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

#include <TrackerEvent.h>

Inheritance diagram for Ocean::Tracking::Offline::ProgressEvent:

Public Types
enum	ProgressEventSubType { PEST_INVALID = 0 , PEST_TRACKER_PROCESS , PEST_ANALYSIS , PEST_TRACKING }
	Definition of individual progress event sub-types. More...

Public Member Functions
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.

Protected Member Functions
	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
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 the base class for all progress events.

Progress events are sent whenever the progress of a component changes.

Member Enumeration Documentation

◆ ProgressEventSubType

enum Ocean::Tracking::Offline::ProgressEvent::ProgressEventSubType

Definition of individual progress event sub-types.

Enumerator
PEST_INVALID	An invalid event sub-type.
PEST_TRACKER_PROCESS	An tracker process sub-type event.
PEST_ANALYSIS	An analysis sub-type event.
PEST_TRACKING	A tracking sub-type event.

Constructor & Destructor Documentation

◆ ProgressEvent()

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

inlineprotected

Creates a new progress event object.

Parameters

subtype	The subtype of the event
trackerId	Unique id of the tracker that sent this event
componentProgress	The progress of the component that sent this event, with range [0, 100]

Member Function Documentation

◆ componentProgress()

unsigned int Ocean::Tracking::Offline::ProgressEvent::componentProgress ( ) const

inline

Returns the progress of a component in percent.

Returns: Component progress, with range [0, 100]

◆ subtypeName()

std::string Ocean::Tracking::Offline::ProgressEvent::subtypeName ( ) const

overridevirtual

Returns the sub-type name of this event object.

See also: TrackerEvent::subtypeName().

Implements Ocean::Tracking::Offline::TrackerEvent.

Field Documentation

◆ componentProgress_

unsigned int Ocean::Tracking::Offline::ProgressEvent::componentProgress_ = 0u

protected

The component progress in percent.

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

TrackerEvent.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes