IntPointerParameter class. A int parameter class that wraps an external int variable.
More...
#include <IntPointerParameter.hpp>
|
| IntPointerParameter (const std::string name, int *valuePointer, const int minimumValue, const int maximumValue) |
| IntPointerParameter constructor with a int pointer.
|
|
| IntPointerParameter (std::string name, std::atomic< int > *atomicValuePointer, const int minimumValue, const int maximumValue) |
| IntPointerParameter constructor with an atomic int pointer.
|
|
int | getValue () const override |
| Gets the current value of the parameter.
|
|
void | setValue (const int newValue) override |
| Sets a new value for the parameter.
|
|
int | getMinimumValue () const override |
| Gets the minimum value for the parameter.
|
|
int | getMaximumValue () const override |
| Gets the maximum value for the parameter.
|
|
| IntParameter (const std::string name) |
| IntParameter constructor.
|
|
virtual | ~IntParameter ()=default |
| IntParameter 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 |
|
IntPointerParameter class. A int parameter class that wraps an external int variable.
◆ IntPointerParameter() [1/2]
switchboard::IntPointerParameter::IntPointerParameter |
( |
const std::string | name, |
|
|
int * | valuePointer, |
|
|
const int | minimumValue, |
|
|
const int | maximumValue ) |
IntPointerParameter constructor with a int pointer.
- Parameters
-
name | The name of the parameter. |
valuePointer | Pointer to the boolean value. |
minimumValue | Minimum value for the parameter. |
maximumValue | Maximum value for the parameter. |
◆ IntPointerParameter() [2/2]
switchboard::IntPointerParameter::IntPointerParameter |
( |
std::string | name, |
|
|
std::atomic< int > * | atomicValuePointer, |
|
|
const int | minimumValue, |
|
|
const int | maximumValue ) |
IntPointerParameter constructor with an atomic int pointer.
- Parameters
-
name | The name of the parameter. |
atomicValuePointer | Atomic pointer to the boolean value. |
minimumValue | Minimum value for the parameter. |
maximumValue | Maximum value for the parameter. |
◆ getMaximumValue()
int switchboard::IntPointerParameter::getMaximumValue |
( |
| ) |
const |
|
overridevirtual |
◆ getMinimumValue()
int switchboard::IntPointerParameter::getMinimumValue |
( |
| ) |
const |
|
overridevirtual |
◆ getValue()
int switchboard::IntPointerParameter::getValue |
( |
| ) |
const |
|
overridevirtual |
◆ setValue()
void switchboard::IntPointerParameter::setValue |
( |
const int | newValue | ) |
|
|
overridevirtual |
Sets a new value for the parameter.
- Parameters
-
newValue | The new value for the parameter. |
Implements switchboard::IntParameter.