Class Spinnaker::EventHandler

ClassList > Spinnaker > EventHandler

The base class for all event handler types.

• #include <EventHandler.h>

Inherited by the following classes: Spinnaker::IDeviceArrivalEventHandler, Spinnaker::IDeviceEventHandler, Spinnaker::IDeviceRemovalEventHandler, Spinnaker::IImageEventHandler, Spinnaker::IImageListEventHandler, Spinnaker::IInterfaceArrivalEventHandler, Spinnaker::IInterfaceRemovalEventHandler, Spinnaker::ILoggingEventHandler

Public Functions

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

Protected Attributes

Type	Name
EventData *	m_pEventData

Protected Functions

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

Public Functions Documentation

function GetEventPayloadData

const uint8_t * Spinnaker::EventHandler::GetEventPayloadData () 

Gets the event payload data

Returns:

The event payload data

---

function GetEventPayloadDataSize

const size_t Spinnaker::EventHandler::GetEventPayloadDataSize () 

Gets the event payload data size

Returns:

The event payload data size

---

function GetEventType

EventType Spinnaker::EventHandler::GetEventType () 

Gets the event type

Returns:

The event type

---

function SetEventType

void Spinnaker::EventHandler::SetEventType (
    EventType eventType
) 

Sets the event type

Parameters:

• eventType The event type

---

function ~EventHandler

virtual Spinnaker::EventHandler::~EventHandler () 

Virtual Destructor

---

Protected Attributes Documentation

variable m_pEventData

EventData* Spinnaker::EventHandler::m_pEventData;

---

Protected Functions Documentation

function EventHandler

Spinnaker::EventHandler::EventHandler () 

---

function SetEventPayload

void Spinnaker::EventHandler::SetEventPayload (
    uint8_t * offset,
    size_t length
) 

---

function operator=

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

---

Friends Documentation

friend SpinRelayReceiver

class Spinnaker::EventHandler::SpinRelayReceiver (
    Relay::SpinRelayReceiver
) 

---

---

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