DeviceEventHandler Class Reference

A handler to device events. More...

#include <DeviceEventHandler.h>

Inheritance diagram for DeviceEventHandler:

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

Protected Member Functions
DeviceEventHandler &	operator= (const DeviceEventHandler &)
	Assignment operator.
Protected Member Functions inherited from IDeviceEventHandler
	IDeviceEventHandler ()
	IDeviceEventHandler (const IDeviceEventHandler &)
IDeviceEventHandler &	operator= (const IDeviceEventHandler &)
Protected Member Functions inherited from EventHandler
	EventHandler ()
EventHandler &	operator= (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.

Constructor & Destructor Documentation

DeviceEventHandler()

DeviceEventHandler

(

)

Default constructor.

~DeviceEventHandler()

virtual ~DeviceEventHandler ( )

virtual

Virtual destructor.

Member Function Documentation

GetDeviceEventId()

uint64_t GetDeviceEventId ( ) const

virtual

Get the ID of the device event.

Returns

The device event ID

Implements IDeviceEventHandler.

GetDeviceEventName()

GenICam::gcstring GetDeviceEventName ( ) const

virtual

Get the name of the device event.

Returns

The device event name

Implements IDeviceEventHandler.

OnDeviceEvent()

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

pure virtual

Device event callback.

Parameters

eventName

The name of the event

Implements IDeviceEventHandler.

Implemented in DeviceEventHandlerImpl.

operator=()

DeviceEventHandler & operator= ( const DeviceEventHandler &  )

protected

Assignment operator.

---

The documentation for this class was generated from the following file:

• include/DeviceEventHandler.h