![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class InterfaceEventControl provides access to interface specific events, e.g. plug'n play event. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
void | RegisterPnPEvent (EventMode eventMode) |
This function registers a PnPEvent at an Interface object to detect adding and removing of Device objects. More... | |
void | UnregisterPnPEvent () |
This function unregisters a PnPEvent at an Interface object. More... | |
bo_bool | GetPnPEvent (PnPEvent *pPnPEvent, bo_uint64 iTimeout) |
This function fetches a PnPEvent from the Interface object. More... | |
void | CancelGetPnPEvent () |
This function cancels the current waiting operation on the GetPnPEvent function. More... | |
void | RegisterPnPEventHandler (void *callBackOwner, PnPEventHandler pFunc) |
Register a callback function which is called any time a new plug 'n play 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 InterfaceEventControl provides access to interface specific events, e.g. plug'n play event.
Definition at line 1886 of file bgapi2_genicam.hpp.
BGAPI2::Events::InterfaceEventControl::CancelGetPnPEvent | ( | ) |
This function cancels the current waiting operation on the GetPnPEvent 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::InterfaceEventControl::GetPnPEvent | ( | PnPEvent * | pPnPEvent, |
bo_uint64 | iTimeout | ||
) |
This function fetches a PnPEvent from the Interface object.
pPnPEvent | A pointer to a valid object of type PnPEvent. See function Events::PnPEvent::PnpEvent(). |
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 PnPEvent object is not valid. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
BGAPI2::Events::InterfaceEventControl::RegisterPnPEvent | ( | EventMode | eventMode | ) |
This function registers a PnPEvent at an Interface object to detect adding and removing of Device objects.
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::InterfaceEventControl::RegisterPnPEventHandler | ( | void * | callBackOwner, |
PnPEventHandler | pFunc | ||
) |
Register a callback function which is called any time a new plug 'n play 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::InterfaceEventControl::UnregisterPnPEvent | ( | ) |
This function unregisters a PnPEvent at an Interface object.
If RegisterPnPEventHandler 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