Ocean
Ocean::Devices::Tracker::TrackerSample Class Reference

Definition of a sample holding one measurement values of a tracker. More...

Inheritance diagram for Ocean::Devices::Tracker::TrackerSample:

Public Member Functions

ReferenceSystem referenceSystem () const
 Returns the reference system of the tracker. More...
 
- Public Member Functions inherited from Ocean::Devices::Measurement::Sample
const Timestamptimestamp () const
 Returns the sample timestamp. More...
 
const ObjectIdsobjectIds () const
 Returns the sample object ids specifying possible different measurement units. More...
 
const Metadatametadata () const
 Returns the metadata of this sample. More...
 

Protected Member Functions

 TrackerSample (const Timestamp &timestamp, const ReferenceSystem referenceSystem, const ObjectIds &objectIds, const Metadata &metadata)
 Creates a new tracker sample. More...
 
 TrackerSample (const Timestamp &timestamp, const ReferenceSystem referenceSystem, ObjectIds &&objectIds, Metadata &&metadata)
 Creates a new tracker sample. More...
 
- Protected Member Functions inherited from Ocean::Devices::Measurement::Sample
 Sample (const Timestamp &timestamp, const ObjectIds &objectIds, const Metadata &metadata=Metadata())
 Creates a new measurement sample. More...
 
 Sample (const Timestamp &timestamp, ObjectIds &&objectIds, Metadata &&metadata=Metadata())
 Creates a new measurement sample. More...
 
virtual ~Sample ()
 Destructs a sample. More...
 

Protected Attributes

ReferenceSystem referenceSystem_
 Tracking reference system. More...
 
- Protected Attributes inherited from Ocean::Devices::Measurement::Sample
Timestamp timestamp_
 Sample timestamp. More...
 
ObjectIds objectIds_
 Measurement unit object ids. More...
 
Metadata metadata_
 The metadata of this sample. More...
 

Detailed Description

Definition of a sample holding one measurement values of a tracker.

Constructor & Destructor Documentation

◆ TrackerSample() [1/2]

Ocean::Devices::Tracker::TrackerSample::TrackerSample ( const Timestamp timestamp,
const ReferenceSystem  referenceSystem,
const ObjectIds objectIds,
const Metadata metadata 
)
protected

Creates a new tracker sample.

Parameters
timestampSample timestamp
referenceSystemTracking reference system used by the underlying tracker
objectIdsObject ids corresponding to different measurement units of one tracker
metadataOptional metadata of the new sample

◆ TrackerSample() [2/2]

Ocean::Devices::Tracker::TrackerSample::TrackerSample ( const Timestamp timestamp,
const ReferenceSystem  referenceSystem,
ObjectIds &&  objectIds,
Metadata &&  metadata 
)
protected

Creates a new tracker sample.

Parameters
timestampSample timestamp
referenceSystemTracking reference system used by the underlying tracker
objectIdsObject ids corresponding to different measurement units of one tracker
metadataOptional metadata of the new sample

Member Function Documentation

◆ referenceSystem()

Tracker::ReferenceSystem Ocean::Devices::Tracker::TrackerSample::referenceSystem ( ) const
inline

Returns the reference system of the tracker.

Returns
Tracking reference system

Field Documentation

◆ referenceSystem_

ReferenceSystem Ocean::Devices::Tracker::TrackerSample::referenceSystem_
protected

Tracking reference system.


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