TimestampDataComponent Class Reference

#include <ImFusion/Base/TimestampDataComponent.h>

Data component to record both arrival and device timestamps, intended for element-wise usage. More...

Inheritance diagram for TimestampDataComponent:

Detailed Description

Data component to record both arrival and device timestamps, intended for element-wise usage.

Public Member Functions
	TimestampDataComponent (uint64_t device, uint64_t arrival)
	TimestampDataComponent (const TimestampDataComponent &rhs)=default
TimestampDataComponent &	operator= (const TimestampDataComponent &rhs)=default
bool	operator== (const TimestampDataComponent &rhs) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
uint64_t	deviceTimestamp () const
uint64_t	arrivalTimestamp () const
Public Member Functions inherited from DataComponent< TimestampDataComponent >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept
Public Member Functions inherited from BinarySerializable
std::string	saveToString () const
	Saves the state of this object into a string. Internally uses saveToBuffer.
void	loadFromString (const std::string &str)
	Restores the state of this object from a string, internally using loadFromBuffer.

Configurable Interface
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
void	configurationHumanReadable (Properties *p) const

BinarySerializable Interface
size_t	saveBufferSize () const override
	Returns the total amount of bytes required for serialization.
void	loadFromBuffer (const char *buffer, size_t len) override
	Restores the state of this object from a memory buffer, using maximum len bytes.
void	saveToBuffer (char *buffer) const override
	Saves the state of this object into a memory buffer, using maximum saveBufferSize() bytes.

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Member Functions inherited from BinarySerializable
template<typename T>
size_t	serializeMember (char *&buffer, const T *data, size_t n=1) const
	Convenience method to memcpy n*sizeof(T) bytes of data to buffer, followed by an increment of buffer by n*sizeof(T).
template<typename T>
size_t	deserializeMember (const char *&buffer, T *data, size_t n=1)
	Convenience method to memcpy n*sizeof(T) bytes of buffer to data, followed by an increment of buffer by n*sizeof(T).
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

saveBufferSize()

size_t saveBufferSize ( ) const

overridevirtual

Returns the total amount of bytes required for serialization.

Implements BinarySerializable.

loadFromBuffer()

void loadFromBuffer ( const char * buffer, size_t len )

overridevirtual

Restores the state of this object from a memory buffer, using maximum len bytes.

Implements BinarySerializable.

saveToBuffer()

void saveToBuffer ( char * buffer ) const

overridevirtual

Saves the state of this object into a memory buffer, using maximum saveBufferSize() bytes.

Implements BinarySerializable.

---

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

• ImFusion/Base/TimestampDataComponent.h