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

A handler to device arrival and removal events on all interfaces. More...

Inheritance diagram for InterfaceEventHandler:
IInterfaceEventHandler IDeviceArrivalEventHandler IDeviceRemovalEventHandler EventHandler EventHandler InterfaceEventHandlerImpl InterfaceEventHandlerImpl

Public Member Functions

 InterfaceEventHandler ()
 Default constructor. More...
 
virtual ~InterfaceEventHandler ()
 Virtual destructor. More...
 
virtual void OnDeviceArrival (uint64_t serialNumber)=0
 Device arrival event callback. More...
 
virtual void OnDeviceRemoval (uint64_t serialNumber)=0
 Callback to the device removal event. More...
 
- Public Member Functions inherited from IInterfaceEventHandler
virtual ~IInterfaceEventHandler ()
 
- Public Member Functions inherited from IDeviceArrivalEventHandler
virtual ~IDeviceArrivalEventHandler ()
 
- 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...
 
- Public Member Functions inherited from IDeviceRemovalEventHandler
virtual ~IDeviceRemovalEventHandler ()
 

Protected Member Functions

InterfaceEventHandleroperator= (const InterfaceEventHandler &)
 Assignment operator. More...
 
- Protected Member Functions inherited from IInterfaceEventHandler
 IInterfaceEventHandler ()
 
 IInterfaceEventHandler (const IInterfaceEventHandler &)
 
IInterfaceEventHandleroperator= (const IInterfaceEventHandler &)
 
- Protected Member Functions inherited from IDeviceArrivalEventHandler
 IDeviceArrivalEventHandler ()
 
 IDeviceArrivalEventHandler (const IDeviceArrivalEventHandler &)
 
IDeviceArrivalEventHandleroperator= (const IDeviceArrivalEventHandler &)
 
- Protected Member Functions inherited from EventHandler
 EventHandler ()
 
EventHandleroperator= (const EventHandler &)
 
void SetEventPayload (uint8_t *offset, size_t length)
 
- Protected Member Functions inherited from IDeviceRemovalEventHandler
 IDeviceRemovalEventHandler ()
 
 IDeviceRemovalEventHandler (const IDeviceRemovalEventHandler &)
 
IDeviceRemovalEventHandleroperator= (const IDeviceRemovalEventHandler &)
 

Additional Inherited Members

- Protected Attributes inherited from EventHandler
EventData * m_pEventData
 

Detailed Description

A handler to device arrival and removal events on all interfaces.

Examples:
AcquisitionMultipleCameraRecovery.cpp, and EnumerationEvents.cpp.

Constructor & Destructor Documentation

Default constructor.

virtual ~InterfaceEventHandler ( )
virtual

Virtual destructor.

Member Function Documentation

virtual void OnDeviceArrival ( uint64_t  serialNumber)
pure virtual

Device arrival event callback.

Implements IInterfaceEventHandler.

Implemented in InterfaceEventHandlerImpl, and InterfaceEventHandlerImpl.

virtual void OnDeviceRemoval ( uint64_t  serialNumber)
pure virtual

Callback to the device removal event.

Parameters
serialNumberThe serial number of the removed device

Implements IInterfaceEventHandler.

Implemented in InterfaceEventHandlerImpl, and InterfaceEventHandlerImpl.

InterfaceEventHandler& operator= ( const InterfaceEventHandler )
protected

Assignment operator.


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