Ocean
Ocean::Tracking::Offline::StateEvent Class Reference

This class is the base class for all state events. More...

Inheritance diagram for Ocean::Tracking::Offline::StateEvent:

Public Types

enum  StateEventSubType {
  SEST_INVALID = 0 , SEST_CAMERA_CALIBRATION , SEST_TRACKER_TRANSFORMATION , SEST_TRACKER_POSE ,
  SEST_TRACKER_POSES , SEST_TRACKER_PLANE
}
 Definition of individual state event sub-types. More...
 

Public Member Functions

std::string subtypeName () const override
 Returns the sub-type name of this event object. More...
 
- Public Member Functions inherited from Ocean::Tracking::Offline::TrackerEvent
unsigned int trackerId () const
 Returns the unique id of the tracker that sent this event. More...
 
std::string typeName () const
 Returns the type name of this event. More...
 
- Public Member Functions inherited from Ocean::Event
virtual ~Event ()
 Destructs an event object. More...
 
unsigned int type () const
 Returns the type of this event. More...
 
unsigned int subtype () const
 Returns the sub-type of this event. More...
 
template<typename T >
const T & cast () const
 Casts this event to an event with specified type. More...
 
template<typename T >
T & cast ()
 Casts this event to an event with specified type. More...
 

Protected Member Functions

 StateEvent (const unsigned int subtype, const unsigned int trackerId)
 Creates a new state event object. More...
 
- 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. More...
 
- Protected Member Functions inherited from Ocean::Event
 Event (const unsigned int type, const unsigned int subtype)
 Creates a new event object. More...
 

Additional Inherited Members

- Protected Attributes inherited from Ocean::Tracking::Offline::TrackerEvent
unsigned int trackerId_ = 0u
 The unique tracker id of the tracker that sent this event. More...
 
- Protected Attributes inherited from Ocean::Event
unsigned int eventType
 The type of the event. More...
 
unsigned int eventSubtype
 The sub-type of the event. More...
 

Detailed Description

This class is the base class for all state events.

Member Enumeration Documentation

◆ StateEventSubType

Definition of individual state event sub-types.

Enumerator
SEST_INVALID 

An invalid event sub-type.

SEST_CAMERA_CALIBRATION 

A camera calibration sub-type event.

SEST_TRACKER_TRANSFORMATION 

A tracker transformation sub-type event.

SEST_TRACKER_POSE 

A tracker pose sub-type event.

SEST_TRACKER_POSES 

A tracker poses sub-type event.

SEST_TRACKER_PLANE 

A tracker plane sub-type event.

Constructor & Destructor Documentation

◆ StateEvent()

Ocean::Tracking::Offline::StateEvent::StateEvent ( const unsigned int  subtype,
const unsigned int  trackerId 
)
inlineexplicitprotected

Creates a new state event object.

Parameters
subtypeThe subtype of the event
trackerIdUnique id of the tracker that sent this event

Member Function Documentation

◆ subtypeName()

std::string Ocean::Tracking::Offline::StateEvent::subtypeName ( ) const
overridevirtual

Returns the sub-type name of this event object.

See also
TrackerEvent::subtypeName().

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


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