icl_core::DataHeader Struct Reference

#include <DataHeader.h>

List of all members.

Public Member Functions
	DataHeader ()
	DataHeader (const std::string &coordinate_system, const boost::posix_time::ptime &timestamp, uint32_t sequence_number=0)
	Constructor.
	~DataHeader ()
	Destructor.
Public Attributes
std::string	coordinate_system
	An identifier for the coordinate system used.
std::size_t	dsin
uint32_t	sequence_number
	A sequence number to distinguish data with identical timestamps.
boost::posix_time::ptime	timestamp
	A timestamp, e.g. when data was recorded / has to be considered.

---

Detailed Description

A generic header which can be used to associate a coordinate system ID, a timestamp, a sequence number and a device-specific item number with any kind of datum.

See also:

icl_core::Stamped

Definition at line 61 of file DataHeader.h.

---

Constructor & Destructor Documentation

icl_core::DataHeader::DataHeader

(

)

[inline]

Default constructor. Sets an empty coordinate system identifier, an invalid timestamp and a sequence number of zero.

Definition at line 66 of file DataHeader.h.

icl_core::DataHeader::DataHeader	(	const std::string &	coordinate_system,
		const boost::posix_time::ptime &	timestamp,
		uint32_t	sequence_number = 0
	)		[inline]

Constructor.

Definition at line 73 of file DataHeader.h.

icl_core::DataHeader::~DataHeader

(

)

[inline]

Destructor.

Definition at line 82 of file DataHeader.h.

---

Member Data Documentation

std::string icl_core::DataHeader::coordinate_system

An identifier for the coordinate system used.

Definition at line 86 of file DataHeader.h.

std::size_t icl_core::DataHeader::dsin

A device-specific item number. This is useful if the data items already come with some kind of internal numbering, e.g. the internal frame count from a camera sensor.

See also:

icl_core::sourcesink::DSIN

Definition at line 96 of file DataHeader.h.

uint32_t icl_core::DataHeader::sequence_number

A sequence number to distinguish data with identical timestamps.

Definition at line 90 of file DataHeader.h.

boost::posix_time::ptime icl_core::DataHeader::timestamp

A timestamp, e.g. when data was recorded / has to be considered.

Definition at line 88 of file DataHeader.h.

---

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

• DataHeader.h