Logo
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
Public Member Functions | List of all members
BGAPI2::Events::InterfaceEventControl Class Reference

The class InterfaceEventControl provides access to interface specific events, e.g. plug'n play event. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::Events::InterfaceEventControl:
BGAPI2::Events::EventControl BGAPI2::Interface

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...
 
- Public Member Functions inherited from BGAPI2::Events::EventControl
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...
 

Detailed Description

The class InterfaceEventControl provides access to interface specific events, e.g. plug'n play event.

Definition at line 1886 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ CancelGetPnPEvent()

BGAPI2::Events::InterfaceEventControl::CancelGetPnPEvent ( )

This function cancels the current waiting operation on the GetPnPEvent function.

Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.
Exceptions::ErrorExceptionUnexpected Error. An internal pointer is not valid.

◆ GetPnPEvent()

BGAPI2::Events::InterfaceEventControl::GetPnPEvent ( PnPEvent pPnPEvent,
bo_uint64  iTimeout 
)

This function fetches a PnPEvent from the Interface object.

Parameters
pPnPEventA pointer to a valid object of type PnPEvent. See function Events::PnPEvent::PnpEvent().
iTimeoutAfter this time, the function delivers latest.
Returns
bo_bool A flag that indicates whether a PnPEvent was fetched.
Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::InvalidParameterExceptionThe passed PnPEvent object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

◆ RegisterPnPEvent()

BGAPI2::Events::InterfaceEventControl::RegisterPnPEvent ( EventMode  eventMode)

This function registers a PnPEvent at an Interface object to detect adding and removing of Device objects.

Parameters
eventModeThe event mode specifies the way how to fetch an incoming event.
Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::InvalidParameterExceptionOnly the event mode polling is available. See enumeration EventMode.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

◆ RegisterPnPEventHandler()

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.

Parameters
callBackOwnerAny object, stays at it is.
pFuncCallback event handler.
Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ErrorExceptionNo memory available.

◆ UnregisterPnPEvent()

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
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

The documentation for this class was generated from the following file:
bgapi: BGAPI::Camera Class Reference

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