InstrumentCalibrationDataComponent Class Reference

#include <ImFusion/Stream/InstrumentCalibrationDataComponent.h>

Data component representing the calibration matrix for a set of instruments. More...

Inheritance diagram for InstrumentCalibrationDataComponent:

Detailed Description

Data component representing the calibration matrix for a set of instruments.

Classes
struct	Calibration

Public Member Functions
bool	operator== (const InstrumentCalibrationDataComponent &other) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
std::optional< Calibration >	calibration (const std::string &instrumentID) const
const std::map< std::string, Calibration > &	calibrations () const
void	setCalibration (const std::string &instrumentID, const mat4 &spatial, double temporal=0.0)
	Sets the calibration matrix using a string as unique ID to identify the instrument.
void	setCalibration (const std::string &instrumentID, const Calibration &calib)
virtual void	configure (const Properties *) override
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from DataComponent< InstrumentCalibrationDataComponent >
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 Attributes
Signal< const std::string &, const Calibration & >	calibrationChanged
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
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

inlineoverridevirtual

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.

setCalibration()

void setCalibration	(	const std::string &	instrumentID,
		const mat4 &	spatial,
		double	temporal = 0.0 )

Sets the calibration matrix using a string as unique ID to identify the instrument.

Optionally adds a temporal calibration representing the offset of this instrument.

configure()

virtual 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()

virtual 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.

---

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

• ImFusion/Stream/InstrumentCalibrationDataComponent.h