Switchboard SDK
Loading...
Searching...
No Matches
switchboard::FloatStoredParameter Class Reference

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

#include <FloatStoredParameter.hpp>

Inheritance diagram for switchboard::FloatStoredParameter:
switchboard::FloatParameter switchboard::Parameter

Public Member Functions

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.
 
WASM float getValue () const override
 Gets the current value of the parameter.
 
WASM void setValue (const float newValue) override
 Sets a new value for the parameter.
 
WASM float getMinimumValue () const override
 Gets the minimum value for the parameter.
 
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
 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

- Public Types inherited from switchboard::Parameter
enum class  Type {
  Float , Bool , Int , UInt ,
  String
}
 
- Protected Attributes inherited from switchboard::Parameter
Type type
 
std::string id
 
std::string name
 
std::string description
 

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
idThe unique identifier of the parameter.
nameThe name of the parameter.
descriptionThe description of the parameter.
defaultValueDefault float value.
minimumValueMinimum value for the parameter.
maximumValueMaximum 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
newValueThe new value for the parameter.

Implements switchboard::FloatParameter.