switchboard::FloatStoredParameter Class Reference

FloatStoredParameter class. A float parameter class that contains an float variable. More...

#include <FloatStoredParameter.hpp>

Inheritance diagram for switchboard::FloatStoredParameter:

Public Member Functions
SB_WASM	FloatStoredParameter (const std::string &id, const std::string &name, const std::string &description, const float defaultValue, const float minimumValue, const float maximumValue)
	FloatStoredParameter constructor with a default value.
SB_WASM float	getValue () const override
	Gets the current value of the parameter.
SB_WASM void	setValue (const float newValue) override
	Sets a new value for the parameter.
SB_WASM float	getMinimumValue () const override
	Gets the minimum value for the parameter.
SB_WASM 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
std::any	getAnyValue () override

Detailed Description

FloatStoredParameter class. A float parameter class that contains an float variable.

Constructor & Destructor Documentation

FloatStoredParameter()

switchboard::FloatStoredParameter::FloatStoredParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		const float	defaultValue,
		const float	minimumValue,
		const float	maximumValue )

FloatStoredParameter constructor with a default value.

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
defaultValue	Default float value.
minimumValue	Minimum value for the parameter.
maximumValue	Maximum value for the parameter.

Member Function Documentation

getMaximumValue()

float switchboard::FloatStoredParameter::getMaximumValue ( ) const

overridevirtual

Gets the maximum value for the parameter.

Returns

The maximum value.

Implements switchboard::FloatParameter.

getMinimumValue()

float switchboard::FloatStoredParameter::getMinimumValue ( ) const

overridevirtual

Gets the minimum value for the parameter.

Returns

The minimum value.

Implements switchboard::FloatParameter.

getValue()

float switchboard::FloatStoredParameter::getValue ( ) const

overridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::FloatParameter.

setValue()

void switchboard::FloatStoredParameter::setValue ( const float newValue )

overridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::FloatParameter.