ItalaApiC  1.3.3
Functions
System

Functions

ITALA_API_C ItalaError SYS_Initialize ()
 
ITALA_API_C ItalaError SYS_Dispose ()
 
ITALA_API_C ItalaError SYS_EnumerateDevices (uint64_t timeout)
 
ITALA_API_C ItalaError SYS_EnumerateDevicesByInterface (InterfaceInfo itfInfo, uint64_t timeout)
 
ITALA_API_C ItalaError SYS_EnumerateDevicesByInterfaces (InterfaceInfo *itfInfoList, size_t size, uint64_t timeout)
 
ITALA_API_C ItalaError SYS_GetDeviceCount (size_t *deviceCount)
 
ITALA_API_C ItalaError SYS_GetDeviceByIndex (size_t index, DeviceInfo *deviceInfo)
 
ITALA_API_C ItalaError SYS_CreateDevice (DeviceInfo deviceInfo, H_DEVICE *phDevice)
 
ITALA_API_C ItalaError SYS_GetNodeMap (H_NODEMAP *phNodemap)
 
ITALA_API_C ItalaError SYS_EnumerateInterfaces ()
 
ITALA_API_C ItalaError SYS_GetInterfaceCount (size_t *interfaceCount)
 
ITALA_API_C ItalaError SYS_GetInterfaceByIndex (size_t index, InterfaceInfo *itfInfo)
 
ITALA_API_C ItalaError SYS_GetInterfaceNodemap (InterfaceInfo itfInfo, H_NODEMAP *phNodeMap)
 

Detailed Description

All the methods related to the systems.

Function Documentation

◆ SYS_Initialize()

ITALA_API_C ItalaError SYS_Initialize ( )

Entry point of the runtime. It allocates all necessary resources and creates the system instance. Only one system can be created at a time. If a system instance is already alive, a call to this function leads to an error.

Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_Dispose()

ITALA_API_C ItalaError SYS_Dispose ( )

Dispose the instance of the System.

Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_EnumerateDevices()

ITALA_API_C ItalaError SYS_EnumerateDevices ( uint64_t  timeout)

Enumerates devices across all interfaces. The maximum number of enumerated devices is 255. To retrieve the number of devices discovered and retrive them by index use:

See also
SYS_GetSizeLastEnumeration and
SYS_GetByIndexLastEnumeration.
Parameters
[in]timeoutMaximum amount of time in ms for the enumeration to terminate.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_EnumerateDevicesByInterface()

ITALA_API_C ItalaError SYS_EnumerateDevicesByInterface ( InterfaceInfo  itfInfo,
uint64_t  timeout 
)

Enumerates all devices under a specific network interface. The maximum number of enumerated devices is 255.To retrieve the number of devices discovered and retrive them by index use:

See also
SYS_GetSizeLastEnumeration and
SYS_GetByIndexLastEnumeration.
Parameters
[in]itfInfoInterface info of the specific network interface.
[in]timeoutMaximum amount of time in ms for the enumeration to terminate.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_EnumerateDevicesByInterfaces()

ITALA_API_C ItalaError SYS_EnumerateDevicesByInterfaces ( InterfaceInfo itfInfoList,
size_t  size,
uint64_t  timeout 
)

Enumerates all devices under a list of specific interfaces. The maximum number of enumerated devices is 255..To retrieve the number of devices discovered and retrive them by index use:

See also
SYS_GetSizeLastEnumeration and
SYS_GetByIndexLastEnumeration.
Parameters
[in]itfInfoListInterface info array of the specific network interface.
[in]sizeAmount of interfaces contained in itfInfoList.
[in]timeoutMaximum amount of time in ms for the enumeration to terminate.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetDeviceCount()

ITALA_API_C ItalaError SYS_GetDeviceCount ( size_t *  deviceCount)

Retrieve the number of devices enumerated the last time an EnumerationDevices method have been called.

Parameters
[out]deviceCountThe amount of devices the last enumeration have discovered.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetDeviceByIndex()

ITALA_API_C ItalaError SYS_GetDeviceByIndex ( size_t  index,
DeviceInfo deviceInfo 
)

Retrieve the device info by index.

Parameters
[in]indexIndex of the device to retrieve.
[out]deviceInfoDevice info retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_CreateDevice()

ITALA_API_C ItalaError SYS_CreateDevice ( DeviceInfo  deviceInfo,
H_DEVICE *  phDevice 
)

Creates a device instance which represents a physical device, given its identyfing info. The maximum number of simultaneously created devices is 50. When no longer needed, device instances must be disposed via DEV_Dispose().

Parameters
[in]deviceInfoDevice info of the specific device to create.
[out]phDeviceHandle to Device instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetNodeMap()

ITALA_API_C ItalaError SYS_GetNodeMap ( H_NODEMAP *  phNodemap)

Get the GenICam nodemap of the GenTL System module. The nodemap instance is accessible via GenApi NODEMAP_ functinos and allows the user to configure the behaviour of the system.

Parameters
[out]phNodemapHandle to NodeMap instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_EnumerateInterfaces()

ITALA_API_C ItalaError SYS_EnumerateInterfaces ( )

Enumerates the available network interfaces.

Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetInterfaceCount()

ITALA_API_C ItalaError SYS_GetInterfaceCount ( size_t *  interfaceCount)

Retrieve the number of interfaces enumerated.

Parameters
[out]interfaceCountThe amount of interfaces the last enumeration have discovered.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetInterfaceByIndex()

ITALA_API_C ItalaError SYS_GetInterfaceByIndex ( size_t  index,
InterfaceInfo itfInfo 
)

Retrieve interface info by index.

Parameters
[in]indexIndex of the device to retrieve.
[out]itfInfoInterface info retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ SYS_GetInterfaceNodemap()

ITALA_API_C ItalaError SYS_GetInterfaceNodemap ( InterfaceInfo  itfInfo,
H_NODEMAP *  phNodeMap 
)

Get the GenICam nodemap of a network interface. The nodemap instance is accessible via GenApi NODEMAP_ functinos and allows the user to configure the behaviour of the interface.

Parameters
[in]itfInfonterface info of the specific network interface.
[out]phNodeMapMHandle to Nodemap instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.