Class Spinnaker::DeviceEventHandler¶

ClassList > Spinnaker > DeviceEventHandler

A handler to device events. More...

#include <DeviceEventHandler.h>

Inherits the following classes: Spinnaker::IDeviceEventHandler

Public Functions¶

Type	Name
	DeviceEventHandler ()
virtual uint64_t	GetDeviceEventId () const
virtual GenICam::gcstring	GetDeviceEventName () const
virtual void	OnDeviceEvent (Spinnaker::GenICam::gcstring eventName) = 0
virtual	~DeviceEventHandler ()

Public Functions inherited from Spinnaker::IDeviceEventHandler¶

See Spinnaker::IDeviceEventHandler

Type	Name
virtual uint64_t	GetDeviceEventId () const = 0
virtual GenICam::gcstring	GetDeviceEventName () const = 0
virtual void	OnDeviceEvent (Spinnaker::GenICam::gcstring eventName) = 0
virtual	~IDeviceEventHandler ()

Public Functions inherited from Spinnaker::EventHandler¶

See Spinnaker::EventHandler

Type	Name
const uint8_t *	GetEventPayloadData ()
const size_t	GetEventPayloadDataSize ()
EventType	GetEventType ()
void	SetEventType (EventType eventType)
virtual	~EventHandler ()

Protected Attributes inherited from Spinnaker::EventHandler¶

See Spinnaker::EventHandler

Type	Name
EventData *	m_pEventData

Protected Functions¶

Type	Name
DeviceEventHandler &	operator= (const DeviceEventHandler &)

Protected Functions inherited from Spinnaker::IDeviceEventHandler¶

See Spinnaker::IDeviceEventHandler

Type	Name
	IDeviceEventHandler ()
	IDeviceEventHandler (const IDeviceEventHandler &)
IDeviceEventHandler &	operator= (const IDeviceEventHandler &)

Protected Functions inherited from Spinnaker::EventHandler¶

See Spinnaker::EventHandler

Type	Name
	EventHandler ()
void	SetEventPayload (uint8_t * offset, size_t length)
EventHandler &	operator= (const EventHandler &)

Detailed Description¶

Deprecated

Use GenApi::Register() and GenApi::Unregister() for handling device node callbacks instead.

Public Functions Documentation¶

function DeviceEventHandler¶

Spinnaker::DeviceEventHandler::DeviceEventHandler ()

Default constructor.

function GetDeviceEventId¶

virtual uint64_t Spinnaker::DeviceEventHandler::GetDeviceEventId () const

Get the ID of the device event.

Returns:

The device event ID

Implements Spinnaker::IDeviceEventHandler::GetDeviceEventId

function GetDeviceEventName¶

virtual GenICam::gcstring Spinnaker::DeviceEventHandler::GetDeviceEventName () const

Get the name of the device event.

Returns:

The device event name

Implements Spinnaker::IDeviceEventHandler::GetDeviceEventName

function OnDeviceEvent¶

virtual void Spinnaker::DeviceEventHandler::OnDeviceEvent (
    Spinnaker::GenICam::gcstring eventName
) = 0

Device event callback.

Parameters:

eventName The name of the event

Implements Spinnaker::IDeviceEventHandler::OnDeviceEvent

function ~DeviceEventHandler¶

virtual Spinnaker::DeviceEventHandler::~DeviceEventHandler ()

Virtual destructor.

Protected Functions Documentation¶

function operator=¶

DeviceEventHandler & Spinnaker::DeviceEventHandler::operator= (
    const DeviceEventHandler &
)

Assignment operator.

The documentation for this class was generated from the following file C:/workspace/include/DeviceEventHandler.h