switchboard::FloatCallbackParameter< T > Class Template Reference

FloatCallbackParameter class. A float parameter class that wraps a getter and a setter methods. More...

#include <FloatCallbackParameter.hpp>

Inheritance diagram for switchboard::FloatCallbackParameter< T >:

Public Types
typedef float(T::*)	FloatGetter() const
typedef void(T::*)	FloatSetter(float)
Public Types inherited from switchboard::Parameter
enum class	Type {   Float , Bool , Int , UInt ,   String }

Public Member Functions
	FloatCallbackParameter (const std::string &id, const std::string &name, const std::string &description, T *instance, FloatGetter getter, FloatSetter setter, const float minimumValue, const float maximumValue)
	FloatCallbackParameter constructor.
float	getValue () const override
	Gets the current value of the parameter.
void	setValue (const float newValue) override
	Sets a new value for the parameter.
float	getMinimumValue () const override
	Gets the minimum value for the parameter.
float	getMaximumValue () const override
	Gets the maximum value for the parameter.
Public Member Functions inherited from switchboard::FloatParameter
	FloatParameter (const std::string &id, const std::string &name, const std::string &description)
	FloatParameter constructor.
virtual	~FloatParameter ()=default
	FloatParameter destructor.
void	setValue (std::any newValue) override
	Sets the value of the parameter.
Public Member Functions inherited from switchboard::Parameter
	Parameter (const Type type, const std::string &id, const std::string &name, const std::string &description)
	Construct a new Parameter object.
virtual	~Parameter ()=default
	Parameter destructor.
Type	getType () const
	Gets the type of the parameter.
const std::string &	getID () const
	Gets the unique identifier of the parameter.
const std::string &	getName () const
	Gets the name of the parameter.
const std::string &	getDescription () const
	Gets the description of the parameter.

Additional Inherited Members
Protected Attributes inherited from switchboard::Parameter
Type	type
std::string	id
std::string	name
std::string	description

Detailed Description

template<typename T>
class switchboard::FloatCallbackParameter< T >

FloatCallbackParameter class. A float parameter class that wraps a getter and a setter methods.

Constructor & Destructor Documentation

FloatCallbackParameter()

template<typename T >

switchboard::FloatCallbackParameter< T >::FloatCallbackParameter ( const std::string & id, const std::string & name, const std::string & description, T * instance, FloatGetter getter, FloatSetter setter, const float minimumValue, const float maximumValue )

inline

FloatCallbackParameter constructor.

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
instance	Pointer to the instance that the getter and setter methods belong to.
getter	The getter method for the parameter.
setter	The setter method for the parameter.
minimumValue	Minimum value for the parameter.
maximumValue	Maximum value for the parameter.

Member Function Documentation

getMaximumValue()

template<typename T >

float switchboard::FloatCallbackParameter< T >::getMaximumValue ( ) const

inlineoverridevirtual

Gets the maximum value for the parameter.

Returns

The maximum value.

Implements switchboard::FloatParameter.

getMinimumValue()

template<typename T >

float switchboard::FloatCallbackParameter< T >::getMinimumValue ( ) const

inlineoverridevirtual

Gets the minimum value for the parameter.

Returns

The minimum value.

Implements switchboard::FloatParameter.

getValue()

template<typename T >

float switchboard::FloatCallbackParameter< T >::getValue ( ) const

inlineoverridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::FloatParameter.

setValue()

template<typename T >

void switchboard::FloatCallbackParameter< T >::setValue ( const float newValue )

inlineoverridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::FloatParameter.