ILIBService Interface Reference

This interface provide functionalities to connect to the IntelliBlink service. More...

Inheritance diagram for ILIBService:

Public Member Functions
int	ExecuteTaskSync (int taskId, ILImage *image, ILIBTaskResult **taskResult)
ILIBAlgoConfig *	GetAlgoConfig (int taskId, LString algoName)
LString	GetErrMsg (int errCode)
int	GetGlobalVariableValue (LString gvName, ILIBData **val)
ILIBTaskConfig *	GetTaskConfig (int taskId)
BOOL	IsReady ()
int	LoadGlobalAction (LString filename)
int	LoadTask (LString filename, int *taskId)
int	PrepareTask (int taskId)
int	SetAlgoConfig (int taskId, LString algoName, ILIBAlgoConfig *algoConfig)
int	SetGlobalVariableValue (LString gvName, ILIBData *val)
int	SetTaskConfig (int taskId, ILIBTaskConfig *taskConfig)
void	SetUp (LString ibPath)
void	TearDown ()
int	UnloadTask (int taskId)

Detailed Description

This interface provide functionalities to connect to the IntelliBlink service.

IntelliBlink is a lightweight intelligent machine vision platform powered by Leaper Vision. You can use its WYSIWYG user interface to develop various optical location and measurement tasks via drag-and-drop operations, and benefits from its powerful algorithm toolkits: Location, Counting, Presence, Math & Logic, Image Filter, Geometry, Calibration, Identification, Classification, etc.

The LPV IB service module helps you to make use of the flexible and scalable IntelliBlink tasks, to integrate, execute and manipulate them in a LPV application.

To use this interface, you should create a LIBService object.

Example Code

C++

ILIBServicePtr ibService = LIBService::Create();
int errCode = ibService->SetUp(L"path to the IntelliBlink root folder, say D:/Programs/IntelliBlink/");
if (errCode != LPVNoError || !ibService->IsReady()) return; // set up IB service failed
// load task
int taskId = 0;
errCode = ibService->LoadTask(L"mytask.task", &taskId);
if (errCode != LPVNoError) return; // load failed
// load global-actions
errCode = ibService->LoadGlobalAction(L"globalAction.json");
if (errCode != LPVNoError) return; // load failed
// change some of the global variables
ILIBDataPtr newData = LIBData::Create();
newData->FromString(L"this is a test");
ibService->SetGlobalVariableValue(L"test_string", newData);
// execute the task
ILIBTaskResultPtr taskResults;
errCode = ibService->ExecuteTaskSync(taskId, img, &taskResults);
if (errCode != LPVNoError) return; // execution failed
// do other stuff, like parse and display task result, change task configuration...
// see ILIBTaskResult, ILIBTaskConfig for more details
ibService->TearDown();

C#

LIBService ibService = new LIBService();
int errCode = ibService.SetUp("path to the IntelliBlink root folder, say D:/Programs/IntelliBlink/");
if (errCode != LPVErrorCode.LPVNoError || !ibService.IsReady()) return; // set up IB service failed
// load task
int taskId = 0;
errCode = ibService.LoadTask("mytask.task", out taskId);
if (errCode != LPVErrorCode.LPVNoError) return; // load failed
// load global-actions
errCode = ibService.LoadGlobalAction("globalAction.json");
if (errCode != LPVErrorCode.LPVNoError) return; // load failed
// change some of the global variables
LIBData newData = new LIBData();
newData.FromString("this is a test");
ibService.SetGlobalVariableValue("test_string", newData);
// execute the task
LIBTaskResult taskResults;
errCode = ibService.ExecuteTaskSync(taskId, img, out taskResults);
if (errCode != LPVErrorCode.LPVNoError) return; // execution failed
// do other stuff, like parse and display task result, change task configuration...
// see ILIBTaskResult, ILIBTaskConfig for more details
ibService.TearDown();

COM

ILIBServicePtr ibService = LIBService::Create();
// or, ILIBServicePtr ibService(__uuidof(LIBService)), for absence of built-in Create functions (before 2.2.0)
int errCode = ibService->SetUp(L"path to the IntelliBlink root folder, say D:/Programs/IntelliBlink/");
if (errCode != LPVNoError || !ibService->IsReady()) return; // set up IB service failed
// load task
int taskId = 0;
errCode = ibService->LoadTask(L"mytask.task", &taskId);
if (errCode != LPVNoError) return; // load failed
// load global-actions
errCode = ibService->LoadGlobalAction(L"globalAction.json");
if (errCode != LPVNoError) return; // load failed
// change some of the global variables
ILIBDataPtr newData = LIBData::Create();
// or, ILIBDataPtr newData(__uuidof(LIBData)), for absence of built-in Create functions (before 2.2.0)
newData->FromString(L"this is a test");
ibService->SetGlobalVariableValue(L"test_string", newData);
// execute the task
ILIBTaskResultPtr taskResults;
errCode = ibService->ExecuteTaskSync(taskId, img, &taskResults);
if (errCode != LPVNoError) return; // execution failed
// do other stuff, like parse and display task result, change task configuration...
// see ILIBTaskResult, ILIBTaskConfig for more details
ibService->TearDown();

Note: This interface is currently not available on Linux / MacOS platform.

Member Function Documentation

ExecuteTaskSync()

int ExecuteTaskSync	(	int	taskId,
		ILImage *	image,
		ILIBTaskResult **	taskResult
	)

Execute the IntelliBlink task synchronously based on the given image.

Parameters

[in]	taskId	The unique task ID.
[in]	image	The input image.
[out]	taskResult	Output the task results.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

GetAlgoConfig()

ILIBAlgoConfig* GetAlgoConfig	(	int	taskId,
		LString	algoName
	)

Get the algorithm configuration with the given task ID and algorithm name.
It is a convenient function for you to get to the algorithm of interest directly.
Return null if failed to find the task with the specified ID or its algorithm with specified name.

Parameters

[in]	taskId	The unique task ID.
[in]	algoName	The unique name of the algorithm tool.

Return values

algoConfig

Return the algorithm configuration.

See also

SetAlgoConfig(), GetTaskConfig().

GetErrMsg()

LString GetErrMsg

(

int

errCode

)

Get the error message with the given error code.

Parameters

[in]

errCode

The error code, returned by IB service functions.

Return values

errMsg

Return the error message.

GetGlobalVariableValue()

int GetGlobalVariableValue	(	LString	gvName,
		ILIBData **	val
	)

Get the value of the global variable with the given name.

Parameters

[in]	gvName	The name of the global variable.
[out]	val	Output the value of the designated global variable.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

SetGlobalVariableValue().

GetTaskConfig()

ILIBTaskConfig* GetTaskConfig

(

int

taskId

)

Get the task configuration with the given task ID. Return null if failed to find the task with the specified ID.

Parameters

[in]

taskId

The unique task ID.

Return values

taskConfig

Return the task configuration.

See also

SetTaskConfig(), GetAlgoConfig().

IsReady()

BOOL IsReady

(

)

Check whether the service is ready.

Return values

val	True for the service is ready, otherwise, return False.

LoadGlobalAction()

int LoadGlobalAction

(

LString

filename

)

Load the global-action module from a specified file. The global action module setup the global variables which are usually used to transfer data between different tasks or execution instances.

Parameters

[in]

filename

The path of global-action model file.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

GetAlgoConfig(), SetTaskConfig().

LoadTask()

int LoadTask	(	LString	filename,
		int *	taskId
	)

Load the IntelliBlink task from a specified file.

Parameters

[in]	filename	Full path of the task file, it could be absolute or relative path with file name and extension.
[out]	taskId	Output the unique task ID.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

UnloadTask()

PrepareTask()

int PrepareTask

(

int

taskId

)

Prepare the IntelliBlink task with the given ID.

Parameters

[in]

taskId

The unique task ID.

See also

LoadTask()

SetAlgoConfig()

int SetAlgoConfig	(	int	taskId,
		LString	algoName,
		ILIBAlgoConfig *	algoConfig
	)

Set the changed configuration to the algorithm with the given task ID and algorithm name.

Parameters

[in]	taskId	The unique task ID.
[in]	algoName	The unique name of the algorithm tool.
[in]	algoConfig	The change configuration.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

GetAlgoConfig(), SetTaskConfig().

SetGlobalVariableValue()

int SetGlobalVariableValue	(	LString	gvName,
		ILIBData *	val
	)

Set the value of the global variable with the given name.

Parameters

[in]	gvName	The name of the global variable.
[in]	val	The value that be set to designated global variable.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

GetGlobalVariableValue().

SetTaskConfig()

int SetTaskConfig	(	int	taskId,
		ILIBTaskConfig *	taskConfig
	)

Set the changed configuration to the task with the given task ID.

Parameters

[in]	taskId	The unique task ID.
[in]	taskConfig	The change configuration.

Return values

errCode

Return the error code if anything is wrong, you may check the error code lookup table, return LPVNoError if succeed.

See also

GetTaskConfig(), SetAlgoConfig().

SetUp()

void SetUp

(

LString

ibPath

)

Set up the IntelliBlink service.
It should be called at the very beginning, before using any of the LPV IB objects.

Parameters

[in]

ibPath

The root folder of the IntelliBlink application.

See also

TearDown().

TearDown()

void TearDown

(

)

Tear down the IntelliBlink service.
It should be called at the end after finish using any of the LPV IB objects.
It's Ok to omit the tear down step, we'll do it automatically when free the service object.

See also

SetUp().

UnloadTask()

int UnloadTask

(

int

taskId

)

Unload the IntelliBlink task with the given ID.

Parameters

[in]

taskId

The unique task ID.

See also

LoadTask()