Spinnaker C++
2.6.0.0
Public Member Functions | Protected Member Functions | List of all members
DeviceEventHandler Class Referenceabstract

A handler to device events. More...

Inheritance diagram for DeviceEventHandler:
IDeviceEventHandler EventHandler DeviceEventHandlerImpl

Public Member Functions

 DeviceEventHandler ()
 Default constructor. More...
 
virtual ~DeviceEventHandler ()
 Virtual destructor. More...
 
virtual void OnDeviceEvent (Spinnaker::GenICam::gcstring eventName)=0
 Device event callback. More...
 
uint64_t GetDeviceEventId () const
 Get the ID of the device event. More...
 
GenICam::gcstring GetDeviceEventName () const
 Get the name of the device event. More...
 
- Public Member Functions inherited from IDeviceEventHandler
virtual ~IDeviceEventHandler ()
 
- Public Member Functions inherited from EventHandler
virtual ~EventHandler ()
 Virtual Destructor. More...
 
void SetEventType (EventType eventType)
 Sets the event type. More...
 
EventType GetEventType ()
 Gets the event type. More...
 
const uint8_t * GetEventPayloadData ()
 Gets the event payload data. More...
 
const size_t GetEventPayloadDataSize ()
 Gets the event payload data size. More...
 

Protected Member Functions

DeviceEventHandleroperator= (const DeviceEventHandler &)
 Assignment operator. More...
 
- Protected Member Functions inherited from IDeviceEventHandler
 IDeviceEventHandler ()
 
 IDeviceEventHandler (const IDeviceEventHandler &)
 
IDeviceEventHandleroperator= (const IDeviceEventHandler &)
 
- Protected Member Functions inherited from EventHandler
 EventHandler ()
 
EventHandleroperator= (const EventHandler &)
 
void SetEventPayload (uint8_t *offset, size_t length)
 

Additional Inherited Members

- Protected Attributes inherited from EventHandler
EventData * m_pEventData
 

Detailed Description

A handler to device events.

Examples:
DeviceEvents.cpp.

Constructor & Destructor Documentation

Default constructor.

virtual ~DeviceEventHandler ( )
virtual

Virtual destructor.

Member Function Documentation

uint64_t GetDeviceEventId ( ) const
virtual

Get the ID of the device event.

Returns
The device event ID

Implements IDeviceEventHandler.

GenICam::gcstring GetDeviceEventName ( ) const
virtual

Get the name of the device event.

Returns
The device event name

Implements IDeviceEventHandler.

virtual void OnDeviceEvent ( Spinnaker::GenICam::gcstring  eventName)
pure virtual

Device event callback.

Parameters
eventNameThe name of the event

Implements IDeviceEventHandler.

Implemented in DeviceEventHandlerImpl.

DeviceEventHandler& operator= ( const DeviceEventHandler )
protected

Assignment operator.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference