CTL::ConstantModel2D Class Reference

The ConstantModel2D class represents a model that always returns a fixed value. More...

#include <datamodels2d.h>

Inheritance diagram for CTL::ConstantModel2D:

Collaboration diagram for CTL::ConstantModel2D:

Public Types
enum	{ Type = 1001 }
Public Types inherited from CTL::AbstractDataModel2D
enum	{ Type = 1000 }
Public Types inherited from CTL::SerializationInterface
enum	{ Type = -1, UserType = 65536 }

Public Member Functions
int	type () const override
float	valueAt (float x, float y) const override
	Always returns the constant specified for this instance. More...
AbstractDataModel2D *	clone () const override
	ConstantModel2D (float amplitude=1.0f)
	Constructs a ConstantModel2D; a model returning a constant value independent of the input. More...
QVariant	parameter () const override
void	setParameter (const QVariant &parameter) override
	Sets the parameters contained in parameter (a QVariantMap). More...
QVariant	toVariant () const override
virtual void	setParameter (const QVariant &parameter)
void	setParameter (const QString &name, const QVariant &value)
Public Member Functions inherited from CTL::AbstractDataModel2D
void	setParameter (const QString &name, const QVariant &value)
void	fromVariant (const QVariant &variant) override
QString	name () const
void	setName (const QString &name)
Chunk2D< float >	sampleChunk (const SamplingRange &xRange, const SamplingRange &yRange, uint nbSamplesX, uint nbSamplesY) const
Public Member Functions inherited from CTL::SerializationInterface
virtual	~SerializationInterface ()=default

Private Attributes
float	_amplitude

Friends
template<class >
struct	SerializationHelper::RegisterWithSerializationHelper

Additional Inherited Members
Protected Member Functions inherited from CTL::AbstractDataModel2D
	AbstractDataModel2D (const AbstractDataModel2D &)=default
	AbstractDataModel2D (AbstractDataModel2D &&)=default
AbstractDataModel2D &	operator= (const AbstractDataModel2D &)=default
AbstractDataModel2D &	operator= (AbstractDataModel2D &&)=default
Protected Member Functions inherited from CTL::SerializationInterface
	SerializationInterface ()=default
	SerializationInterface (const SerializationInterface &)=default
	SerializationInterface (SerializationInterface &&)=default
SerializationInterface &	operator= (const SerializationInterface &)=default
SerializationInterface &	operator= (SerializationInterface &&)=default
Related Functions inherited from CTL::AbstractDataModel2D
std::shared_ptr< AbstractDataModel2D >	operator+ (std::shared_ptr< AbstractDataModel2D > lhs, std::shared_ptr< AbstractDataModel2D > rhs)
std::shared_ptr< AbstractDataModel2D >	operator- (std::shared_ptr< AbstractDataModel2D > lhs, std::shared_ptr< AbstractDataModel2D > rhs)
std::shared_ptr< AbstractDataModel2D >	operator * (std::shared_ptr< AbstractDataModel2D > lhs, std::shared_ptr< AbstractDataModel2D > rhs)
std::shared_ptr< AbstractDataModel2D >	operator/ (std::shared_ptr< AbstractDataModel2D > lhs, std::shared_ptr< AbstractDataModel2D > rhs)
std::shared_ptr< AbstractDataModel2D > &	operator+= (std::shared_ptr< AbstractDataModel2D > &lhs, const std::shared_ptr< AbstractDataModel2D > &rhs)
std::shared_ptr< AbstractDataModel2D > &	operator-= (std::shared_ptr< AbstractDataModel2D > &lhs, const std::shared_ptr< AbstractDataModel2D > &rhs)
std::shared_ptr< AbstractDataModel2D > &	operator *= (std::shared_ptr< AbstractDataModel2D > &lhs, const std::shared_ptr< AbstractDataModel2D > &rhs)
std::shared_ptr< AbstractDataModel2D > &	operator/= (std::shared_ptr< AbstractDataModel2D > &lhs, const std::shared_ptr< AbstractDataModel2D > &rhs)

Detailed Description

The ConstantModel2D class represents a model that always returns a fixed value.

This model maps all input to the same output value specified in the constructor.

Constructor & Destructor Documentation

ConstantModel2D()

CTL::ConstantModel2D::ConstantModel2D ( float  amplitude = 1.0f )

explicit

Constructs a ConstantModel2D; a model returning a constant value independent of the input.

The created model will always return the value amplitude.

Member Function Documentation

parameter()

QVariant CTL::ConstantModel2D::parameter ( ) const

overridevirtual

Returns the parameters of this model as a QVariant.

Default implementation returns an empty QVariant. Override in custom classes to encode all relevant information from the class' members. The returned QVariant must contain all information to fully specify the objects state. In particular, calling setParameter(parameter()) should not change the state of an object.

Reimplemented from CTL::AbstractDataModel2D.

setParameter() [1/3]

void CTL::ConstantModel2D::setParameter ( const QVariant &  parameter )

overridevirtual

Sets the parameters contained in parameter (a QVariantMap).

The value passed to parameter must be a QVariantMap containing the following (key, value)-pair:

-("amplitude", [float] amplitude).

Reimplemented from CTL::AbstractDataModel2D.

setParameter() [2/3]

void CTL::AbstractDataModel2D::setParameter

Sets the parameter with tag name to value, by passing a QVariantMap containing only the name, value pair as its sole entry to setParameter(const QVariant&).

This method is only useful if setParameter(const QVariant&) is implemented in a way that it allows for individual parameters to be set if the QVariant passed to it does only contain a selection of parameters. When overriding setParameter(const QVariant&) in custom classes, this method will be shadowed. In case you implemented setParameter(const QVariant&) in the way described above (i.e. such that setting individual parameters is possible), re-enable this method in the sub-class via

using AbstractDataModel2D::setParameter;

.

setParameter() [3/3]

void CTL::AbstractDataModel2D::setParameter

Sets the parameters of this model based on data held in parameter.

Default implementation does nothing. Override in custom classes to extract all relevant information from parameter and set class members accordingly. A call to this method (given an appropriate input parameter) should prepare the full state of the object. In particular, calling setParameter(parameter()) should not change the state of an object.

toVariant()

QVariant CTL::ConstantModel2D::toVariant ( ) const

overridevirtual

Interface to store all member variables in a QVariant.

Stores the object's type-id.

Reimplement this method such that it stores all newly introduced object data when sub-classing. This needs to cover everything that is necessary to fully determine the state of an object. Best practice is to invoke the base class version of this method to take care of all content originating from underlying base classes.

A typical reimplementation in sub-classes might look like this:

QVariantMap ret = DirectBaseClass::toVariant().toMap();

ret.insert("my member variable", _myMemberVariable);

return ret;

Reimplemented from CTL::AbstractDataModel2D.

type()

int CTL::ConstantModel2D::type ( ) const

inlineoverridevirtual

Returns the type-id of the serializable object. Used in deserialization to determine the proper object type.

Add derived classes to the enumeration using the CTL_TYPE_ID macro.

Reimplemented from CTL::AbstractDataModel2D.

valueAt()

float CTL::ConstantModel2D::valueAt ( float  x, float  y  ) const

overridevirtual

Always returns the constant specified for this instance.

Note that the constant may be set either during construction of via setParameter().

Implements CTL::AbstractDataModel2D.

---

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

• modules/src/models/datamodels2d.h
• modules/src/models/datamodels2d.cpp