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

The class DeviceEventControl provides access to standard events transmitted from the device. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::Events::DeviceEventControl:
BGAPI2::Events::EventControl BGAPI2::Device

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...
 
- 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 DeviceEventControl provides access to standard events transmitted from the device.

Definition at line 2015 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ CancelGetDeviceEvent()

BGAPI2::Events::DeviceEventControl::CancelGetDeviceEvent ( )

This function cancels the current waiting operation on the GetDeviceEvent 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.

◆ GetDeviceEvent()

BGAPI2::Events::DeviceEventControl::GetDeviceEvent ( DeviceEvent pDeviceEvent,
bo_uint64  iTimeout 
)

This function fetches a DeviceEvent from the Device object.

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

◆ RegisterDeviceEvent()

BGAPI2::Events::DeviceEventControl::RegisterDeviceEvent ( EventMode  eventMode)

This function registers a DeviceEvent at an Device object to detect asynchronous events from the physical connected device.

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.

◆ RegisterDeviceEventHandler()

BGAPI2::Events::DeviceEventControl::RegisterDeviceEventHandler ( void *  callBackOwner,
DeviceEventHandler  pFunc 
)

Register a callback function which is called any time a new device 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.

◆ UnregisterDeviceEvent()

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
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