FloatPointerParameter class. A float parameter class that wraps an external float variable.
More...
#include <FloatPointerParameter.hpp>
|
| FloatPointerParameter (const std::string name, float *valuePointer, const float minimumValue, const float maximumValue) |
| FloatPointerParameter constructor with a float pointer.
|
|
| FloatPointerParameter (std::string name, std::atomic< float > *atomicValuePointer, const float minimumValue, const float maximumValue) |
| FloatPointerParameter constructor with an atomic float pointer.
|
|
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.
|
|
| FloatParameter (const std::string name) |
| FloatParameter constructor.
|
|
virtual | ~FloatParameter ()=default |
| FloatParameter destructor.
|
|
| Parameter (const Type type, const std::string name) |
|
virtual | ~Parameter ()=default |
| Parameter destructor.
|
|
const std::string & | getName () const |
| Gets the name of the parameter.
|
|
Type | getType () const |
| Gets the type of the parameter.
|
|
|
enum class | Type { Float
, Bool
, Int
, UInt
} |
|
Type | type |
|
std::string | name |
|
FloatPointerParameter class. A float parameter class that wraps an external float variable.
◆ FloatPointerParameter() [1/2]
switchboard::FloatPointerParameter::FloatPointerParameter |
( |
const std::string | name, |
|
|
float * | valuePointer, |
|
|
const float | minimumValue, |
|
|
const float | maximumValue ) |
FloatPointerParameter constructor with a float pointer.
- Parameters
-
name | The name of the parameter. |
valuePointer | Pointer to the float value. |
minimumValue | Minimum value for the parameter. |
maximumValue | Maximum value for the parameter. |
◆ FloatPointerParameter() [2/2]
switchboard::FloatPointerParameter::FloatPointerParameter |
( |
std::string | name, |
|
|
std::atomic< float > * | atomicValuePointer, |
|
|
const float | minimumValue, |
|
|
const float | maximumValue ) |
FloatPointerParameter constructor with an atomic float pointer.
- Parameters
-
name | The name of the parameter. |
atomicValuePointer | Atomic pointer to the float value. |
minimumValue | Minimum value for the parameter. |
maximumValue | Maximum value for the parameter. |
◆ getMaximumValue()
float switchboard::FloatPointerParameter::getMaximumValue |
( |
| ) |
const |
|
overridevirtual |
◆ getMinimumValue()
float switchboard::FloatPointerParameter::getMinimumValue |
( |
| ) |
const |
|
overridevirtual |
◆ getValue()
float switchboard::FloatPointerParameter::getValue |
( |
| ) |
const |
|
overridevirtual |
◆ setValue()
void switchboard::FloatPointerParameter::setValue |
( |
const float | newValue | ) |
|
|
overridevirtual |