BGAPI2 Device Event Functions
Functions related to the GenICam Device Events. More...
Typedefs | |
typedef struct BGAPI2_DeviceEvent | BGAPI2_DeviceEvent |
Struct for pointers of type DeviceEvent. More... | |
Enumerations | |
enum | BGAPI2_EventMode { EVENTMODE_UNREGISTERED = 0, EVENTMODE_POLLING = 1, EVENTMODE_EVENT_HANDLER = 2 } |
An enumeration containing the string representation of the possible event configurations. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetNode (BGAPI2_DeviceEvent *device_event, const char *name, BGAPI2_Node **node) |
Gets the named node of given map of interface. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetNodeTree (BGAPI2_DeviceEvent *device_event, BGAPI2_NodeMap **node_tree) |
Gets the node map of interface (tree elements) More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetNodeList (BGAPI2_DeviceEvent *device_event, BGAPI2_NodeMap **node_tree) |
Gets the node map of interface (list of entries) More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetName (BGAPI2_DeviceEvent *device_event, char *name, bo_uint64 *string_length) |
Returns the name of device event. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetDisplayName (BGAPI2_DeviceEvent *device_event, char *display_name, bo_uint64 *string_length) |
Returns the "user friendly" display name of device event. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetTimeStamp (BGAPI2_DeviceEvent *device_event, bo_uint64 *time_stamp) |
Returns the timestamp of device event. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_DeviceEvent_GetID (BGAPI2_DeviceEvent *device_event, char *ID, bo_uint64 *string_length) |
Returns the identifier of device event. More... | |
Detailed Description
Functions related to the GenICam Device Events.
Typedef Documentation
◆ BGAPI2_DeviceEvent
typedef struct BGAPI2_DeviceEvent BGAPI2_DeviceEvent |
Struct for pointers of type DeviceEvent.
Enumeration Type Documentation
◆ BGAPI2_EventMode
enum BGAPI2_EventMode |
An enumeration containing the string representation of the possible event configurations.
Function Documentation
◆ BGAPI2_DeviceEvent_GetNode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNode | ( | BGAPI2_DeviceEvent * | device_event, |
const char * | name, | ||
BGAPI2_Node ** | node | ||
) |
Gets the named node of given map of interface.
- Parameters
-
[in] device_event Pointer to the device event [in] name Node name [out] node Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetNodeTree()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNodeTree | ( | BGAPI2_DeviceEvent * | device_event, |
BGAPI2_NodeMap ** | node_tree | ||
) |
Gets the node map of interface (tree elements)
- Parameters
-
[in] device_event Pointer to the device event [out] node_tree Pointer to store the node tree
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetNodeList | ( | BGAPI2_DeviceEvent * | device_event, |
BGAPI2_NodeMap ** | node_tree | ||
) |
Gets the node map of interface (list of entries)
- Parameters
-
[in] device_event Pointer to the device event [out] node_tree Pointer to store the node tree
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetName()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetName | ( | BGAPI2_DeviceEvent * | device_event, |
char * | name, | ||
bo_uint64 * | string_length | ||
) |
Returns the name of device event.
- Parameters
-
[in] device_event Pointer to the device event [in,out] name Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No unit name on device event BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetDisplayName()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetDisplayName | ( | BGAPI2_DeviceEvent * | device_event, |
char * | display_name, | ||
bo_uint64 * | string_length | ||
) |
Returns the "user friendly" display name of device event.
- Parameters
-
[in] device_event Pointer to the device event [in,out] display_name Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE The display name was not included in the XML description of the event BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetTimeStamp()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetTimeStamp | ( | BGAPI2_DeviceEvent * | device_event, |
bo_uint64 * | time_stamp | ||
) |
Returns the timestamp of device event.
- Parameters
-
[in] device_event Pointer to the device event [out] time_stamp Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_AVAILABLE No timestamp on device event of timestamp equal zero BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_DeviceEvent_GetID()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_DeviceEvent_GetID | ( | BGAPI2_DeviceEvent * | device_event, |
char * | ID, | ||
bo_uint64 * | string_length | ||
) |
Returns the identifier of device event.
- Parameters
-
[in] device_event Pointer to the device event [in,out] ID Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NO_DATA Internal error BGAPI2_RESULT_INVALID_BUFFER Internal error, destination buffer too small BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters