TemporaryDataComponent Class Reference

#include <ImFusion/Base/DataComponent.h>

Specialization of DataComponentBase that disables serialization, copying and assignment. More...

Inheritance diagram for TemporaryDataComponent:

Detailed Description

Specialization of DataComponentBase that disables serialization, copying and assignment.

Use this interface for temporary data that is not supposed to be serialized, copied or assigned.

Public Member Functions
std::string	id () const override
	Returns a unique string identifier for this type of data component.
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
bool	assign (const DataComponentBase &) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &) const override
	Compares this data component to other for equality.
void	configure (const Properties *) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *) const override
	Serialize the current object configuration into the given Properties object.
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

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

clone()

std::unique_ptr< DataComponentBase > clone ( ) const

inlineoverridevirtual

Creates a clone of this data component.

Implements DataComponentBase.

assign()

bool assign ( const DataComponentBase & other )

inlineoverridevirtual

Assigns the content of other to this data component.

Parameters

other

Source data component for assignment.

Implements DataComponentBase.

equals()

bool equals ( const DataComponentBase & other ) const

inlineoverridevirtual

Compares this data component to other for equality.

Parameters

other

Other data component to compare this one to.

Implements DataComponentBase.

configure()

void configure ( const Properties * p )

inlineoverridevirtual

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

inlineoverridevirtual

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/Base/DataComponent.h