This class implements the base class for all tracker events. More...

#include <TrackerEvent.h>

Inheritance diagram for Ocean::Tracking::Offline::TrackerEvent:

Public Member Functions
unsigned int	trackerId () const
	Returns the unique id of the tracker that sent this event.

std::string	typeName () const
	Returns the type name of this event.

virtual std::string	subtypeName () const =0
	Returns the sub-type name of this event object.

Public Member Functions inherited from Ocean::Event
virtual	~Event ()
	Destructs an event object.

unsigned int	type () const
	Returns the type of this event.

unsigned int	subtype () const
	Returns the sub-type of this event.

template<typename T >
const T &	cast () const
	Casts this event to an event with specified type.

template<typename T >
T &	cast ()
	Casts this event to an event with specified type.

Protected Member Functions
	TrackerEvent (const unsigned int type, const unsigned int subtype, const unsigned int trackerId)
	Creates a new tracker event object.

Protected Member Functions inherited from Ocean::Event
	Event (const unsigned int type, const unsigned int subtype)
	Creates a new event object.

Protected Attributes
unsigned int	trackerId_ = 0u
	The unique tracker id of the tracker that sent this event.

Protected Attributes inherited from Ocean::Event
unsigned int	eventType
	The type of the event.

unsigned int	eventSubtype
	The sub-type of the event.

Detailed Description

This class implements the base class for all tracker events.

Constructor & Destructor Documentation

◆ TrackerEvent()

Ocean::Tracking::Offline::TrackerEvent::TrackerEvent	(	const unsigned int	type,
		const unsigned int	subtype,
		const unsigned int	trackerId
	)

protected

Creates a new tracker event object.

Parameters

type	The type of the event
subtype	The subtype of the event
trackerId	Id of the tracker that is sending this event

Member Function Documentation

◆ subtypeName()

virtual std::string Ocean::Tracking::Offline::TrackerEvent::subtypeName ( ) const

pure virtual

Returns the sub-type name of this event object.

Returns: Event sub-type name

Implemented in Ocean::Tracking::Offline::ComponentEvent, Ocean::Tracking::Offline::ProgressEvent, and Ocean::Tracking::Offline::StateEvent.

◆ trackerId()

unsigned int Ocean::Tracking::Offline::TrackerEvent::trackerId ( ) const

inline

Returns the unique id of the tracker that sent this event.

Returns: Unique tracker id

◆ typeName()

std::string Ocean::Tracking::Offline::TrackerEvent::typeName ( ) const

Returns the type name of this event.

Returns: Event type name

Field Documentation

◆ trackerId_

unsigned int Ocean::Tracking::Offline::TrackerEvent::trackerId_ = 0u

protected

The unique tracker id of the tracker that sent this event.

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

TrackerEvent.h

Public Member Functions

Protected Member Functions

Protected Attributes