Ocean::Devices::Measurement::Sample Class Reference

Definition of a sample holding a measurement. More...

#include <Measurement.h>

Inheritance diagram for Ocean::Devices::Measurement::Sample:

Public Member Functions
const Timestamp &	timestamp () const
	Returns the sample timestamp.
const Timestamp &	relativeTimestamp () const
	Returns the relative timestamp of this sample.
const ObjectIds &	objectIds () const
	Returns the sample object ids specifying possible different measurement units.
const Metadata &	metadata () const
	Returns the metadata of this sample.
void	setRelativeTimestamp (const Timestamp &relativeTimestamp)
	Sets the relative timestamp of this sample.

Protected Member Functions
	Sample (const Timestamp &timestamp, const ObjectIds &objectIds, const Metadata &metadata=Metadata())
	Creates a new measurement sample.
	Sample (const Timestamp &timestamp, ObjectIds &&objectIds, Metadata &&metadata=Metadata())
	Creates a new measurement sample.
virtual	~Sample ()
	Destructs a sample.

Protected Attributes
Timestamp	timestamp_
	The sample timestamp.
Timestamp	relativeTimestamp_
	The relative sample timestamp.
ObjectIds	objectIds_
	Measurement unit object ids.
Metadata	metadata_
	The metadata of this sample.

Friends
class	ObjectRef< Sample >

Detailed Description

Definition of a sample holding a measurement.

Constructor & Destructor Documentation

Sample() [1/2]

Ocean::Devices::Measurement::Sample::Sample ( const Timestamp &  timestamp, const ObjectIds &  objectIds, const Metadata &  metadata = Metadata()  )

protected

Creates a new measurement sample.

Parameters

timestamp	Sample timestamp
objectIds	Object ids corresponding to different measurement units of one tracker
metadata	Optional metadata of the new sample

Sample() [2/2]

Ocean::Devices::Measurement::Sample::Sample ( const Timestamp &  timestamp, ObjectIds &&  objectIds, Metadata &&  metadata = Metadata()  )

protected

Creates a new measurement sample.

Parameters

timestamp	Sample timestamp
objectIds	Object ids corresponding to different measurement units of one tracker
metadata	Optional metadata of the new sample

~Sample()

virtual Ocean::Devices::Measurement::Sample::~Sample ( )

protectedvirtual

Destructs a sample.

Member Function Documentation

metadata()

const Measurement::Metadata & Ocean::Devices::Measurement::Sample::metadata ( ) const

inline

Returns the metadata of this sample.

Returns

The sample's meta data

objectIds()

const Measurement::ObjectIds & Ocean::Devices::Measurement::Sample::objectIds ( ) const

inline

Returns the sample object ids specifying possible different measurement units.

Returns

Object ids

relativeTimestamp()

const Timestamp & Ocean::Devices::Measurement::Sample::relativeTimestamp ( ) const

inline

Returns the relative timestamp of this sample.

Returns

The sample's relative timestamp

setRelativeTimestamp()

void Ocean::Devices::Measurement::Sample::setRelativeTimestamp ( const Timestamp &  relativeTimestamp )

inline

Sets the relative timestamp of this sample.

Parameters

relativeTimestamp

The sample's relative timestamp to set, must be valid

timestamp()

const Timestamp & Ocean::Devices::Measurement::Sample::timestamp ( ) const

inline

Returns the sample timestamp.

Returns

The sample's timestamp

Friends And Related Symbol Documentation

ObjectRef< Sample >

friend class ObjectRef< Sample >

friend

Field Documentation

metadata_

Metadata Ocean::Devices::Measurement::Sample::metadata_

protected

The metadata of this sample.

objectIds_

ObjectIds Ocean::Devices::Measurement::Sample::objectIds_

protected

Measurement unit object ids.

relativeTimestamp_

Timestamp Ocean::Devices::Measurement::Sample::relativeTimestamp_

protected

The relative sample timestamp.

timestamp_

Timestamp Ocean::Devices::Measurement::Sample::timestamp_

protected

The sample timestamp.

---

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

• Measurement.h