This class implements a progress event for tracking components. More...

Inheritance diagram for Ocean::Tracking::Offline::TrackingProgressEvent:

Public Member Functions
	TrackingProgressEvent (const unsigned int trackerId, const unsigned int componentProgress)
	Creates a new progress event object.

Public Member Functions inherited from Ocean::Tracking::Offline::ProgressEvent
std::string	subtypeName () const override
	Returns the sub-type name of this event object.

unsigned int	componentProgress () const
	Returns the progress of a component in percent.

Public Member Functions inherited from Ocean::Tracking::Offline::TrackerEvent
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.

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.

Static Public Member Functions
static EventRef	createEvent (const unsigned int trackerId, const unsigned int componentProgress)
	Creates a new event reference object.

Additional Inherited Members
Public Types inherited from Ocean::Tracking::Offline::ProgressEvent
enum	ProgressEventSubType { PEST_INVALID = 0 , PEST_TRACKER_PROCESS , PEST_ANALYSIS , PEST_TRACKING }
	Definition of individual progress event sub-types. More...

Protected Member Functions inherited from Ocean::Tracking::Offline::ProgressEvent
	ProgressEvent (const unsigned int subtype, const unsigned int trackerId, const unsigned int componentProgress)
	Creates a new progress event object.

Protected Member Functions inherited from Ocean::Tracking::Offline::TrackerEvent
	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 inherited from Ocean::Tracking::Offline::ProgressEvent
unsigned int	componentProgress_ = 0u
	The component progress in percent.

Protected Attributes inherited from Ocean::Tracking::Offline::TrackerEvent
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 a progress event for tracking components.

Constructor & Destructor Documentation

Ocean::Tracking::Offline::TrackingProgressEvent::TrackingProgressEvent	(	const unsigned int	trackerId,
		const unsigned int	componentProgress
	)

inline

Creates a new progress event object.

Parameters

trackerId	Unique id of the tracker that sent this event
componentProgress	Progress of the sending component in percent, with range [0, 100]

EventRef Ocean::Tracking::Offline::TrackingProgressEvent::createEvent	(	const unsigned int	trackerId,
		const unsigned int	componentProgress
	)

inlinestatic

Creates a new event reference object.

Parameters

trackerId	Unique id of the tracker that sent this event
componentProgress	Progress of the sending component in percent, with range [0, 100]

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