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

Struct for pointers of type DeviceEvent.

Enumeration Type Documentation

◆ BGAPI2_EventMode

An enumeration containing the string representation of the possible event configurations.

Enumerator
EVENTMODE_UNREGISTERED 

Event handling is disabled. No events can be retrieved.

EVENTMODE_POLLING 

Events are retrieved by a function call of the corresponding get function.

EVENTMODE_EVENT_HANDLER 

Events are retrieved by a previously registered callback function.

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_eventPointer to the device event
[in]nameNode name
[out]nodePointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[out]node_treePointer to store the node tree
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[out]node_treePointer to store the node tree
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEError for missing root node
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[in,out]nameNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_IMPLEMENTEDNo unit name on device event
BGAPI2_RESULT_ERRORInternal error (access denied, invalid parameter, ..)
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[in,out]display_nameNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEThe display name was not included in the XML description of the event
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[out]time_stampPointer to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLENo timestamp on device event of timestamp equal zero
BGAPI2_RESULT_INVALID_PARAMETERError 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_eventPointer to the device event
[in,out]IDNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NO_DATAInternal error
BGAPI2_RESULT_INVALID_BUFFERInternal error, destination buffer too small
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters