![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class DeviceEventControl provides access to standard events transmitted from the device. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
void | RegisterDeviceEvent (EventMode eventMode) |
This function registers a DeviceEvent at an Device object to detect asynchronous events from the physical connected device. More... | |
void | UnregisterDeviceEvent () |
This function unregisters a DeviceEvent at an Device object. More... | |
bo_bool | GetDeviceEvent (DeviceEvent *pDeviceEvent, bo_uint64 iTimeout) |
This function fetches a DeviceEvent from the Device object. More... | |
void | CancelGetDeviceEvent () |
This function cancels the current waiting operation on the GetDeviceEvent function. More... | |
void | RegisterDeviceEventHandler (void *callBackOwner, DeviceEventHandler pFunc) |
Register a callback function which is called any time a new device event was received. More... | |
![]() | |
EventMode | GetEventMode () |
This function delivers the current event mode setting. The event mode is controlled by the event register functions. See also enumeration Events::EventMode. More... | |
void * | GetBase () |
Undocumented function. More... | |
The class DeviceEventControl provides access to standard events transmitted from the device.
Definition at line 2015 of file bgapi2_genicam.hpp.
BGAPI2::Events::DeviceEventControl::CancelGetDeviceEvent | ( | ) |
This function cancels the current waiting operation on the GetDeviceEvent function.
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::ErrorException | Unexpected Error. An internal pointer is not valid. |
BGAPI2::Events::DeviceEventControl::GetDeviceEvent | ( | DeviceEvent * | pDeviceEvent, |
bo_uint64 | iTimeout | ||
) |
This function fetches a DeviceEvent from the Device object.
pDeviceEvent | A pointer to a valid object of type DeviceEvent. See function Events::DeviceEvent::DeviceEvent(). |
iTimeout | After this time, the function delivers latest. |
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::InvalidParameterException | The passed DeviceEvent object is not valid. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
BGAPI2::Events::DeviceEventControl::RegisterDeviceEvent | ( | EventMode | eventMode | ) |
This function registers a DeviceEvent at an Device object to detect asynchronous events from the physical connected device.
eventMode | The event mode specifies the way how to fetch an incoming event. |
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::InvalidParameterException | Only the event mode polling is available. See enumeration EventMode. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
BGAPI2::Events::DeviceEventControl::RegisterDeviceEventHandler | ( | void * | callBackOwner, |
DeviceEventHandler | pFunc | ||
) |
Register a callback function which is called any time a new device event was received.
callBackOwner | Any object, stays at it is. |
pFunc | Callback event handler. |
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ErrorException | No memory available. |
BGAPI2::Events::DeviceEventControl::UnregisterDeviceEvent | ( | ) |
This function unregisters a DeviceEvent at an Device object.
If DeviceEventHandler was registered, Thread will be shutdown and Handler removed.
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Jan, 14 2020
Baumer Optronic GmbH,
Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86,
Email:support.cameras@baumer.com