All the methods related to the systems.
◆ 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()
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] | timeout | Maximum amount of time in ms for the enumeration to terminate. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
◆ SYS_EnumerateDevicesByInterface()
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] | itfInfo | Interface info of the specific network interface. |
[in] | timeout | Maximum 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] | itfInfoList | Interface info array of the specific network interface. |
[in] | size | Amount of interfaces contained in itfInfoList. |
[in] | timeout | Maximum 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] | deviceCount | The amount of devices the last enumeration have discovered. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
◆ SYS_GetDeviceByIndex()
Retrieve the device info by index.
- Parameters
-
[in] | index | Index of the device to retrieve. |
[out] | deviceInfo | Device info retrived. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
◆ SYS_CreateDevice()
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] | deviceInfo | Device info of the specific device to create. |
[out] | phDevice | Handle 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] | phNodemap | Handle 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] | interfaceCount | The amount of interfaces the last enumeration have discovered. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
◆ SYS_GetInterfaceByIndex()
Retrieve interface info by index.
- Parameters
-
[in] | index | Index of the device to retrieve. |
[out] | itfInfo | Interface info retrived. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
◆ SYS_GetInterfaceNodemap()
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] | itfInfo | nterface info of the specific network interface. |
[out] | phNodeMap | MHandle to Nodemap instance. |
- Returns
- ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.