Switchboard SDK
|
BoolPointerParameter class. A boolean parameter class that wraps an external bool variable. More...
#include <BoolPointerParameter.hpp>
Public Member Functions | |
BoolPointerParameter (const std::string name, bool *valuePointer) | |
BoolPointerParameter constructor with a bool pointer. | |
BoolPointerParameter (std::string name, std::atomic< bool > *atomicValuePointer) | |
BoolPointerParameter constructor with an atomic bool pointer. | |
bool | getValue () const override |
Gets the current value of the parameter. | |
void | setValue (const bool newValue) override |
Sets a new value for the parameter. | |
Public Member Functions inherited from switchboard::BoolParameter | |
BoolParameter (const std::string name) | |
BoolParameter constructor. | |
virtual | ~BoolParameter ()=default |
BoolParameter destructor. | |
Public Member Functions inherited from switchboard::Parameter | |
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. | |
Additional Inherited Members | |
Public Types inherited from switchboard::Parameter | |
enum class | Type { Float , Bool , Int , UInt } |
Protected Attributes inherited from switchboard::Parameter | |
Type | type |
std::string | name |
BoolPointerParameter class. A boolean parameter class that wraps an external bool variable.
switchboard::BoolPointerParameter::BoolPointerParameter | ( | const std::string | name, |
bool * | valuePointer ) |
BoolPointerParameter constructor with a bool pointer.
name | The name of the parameter. |
valuePointer | Pointer to the boolean value. |
switchboard::BoolPointerParameter::BoolPointerParameter | ( | std::string | name, |
std::atomic< bool > * | atomicValuePointer ) |
BoolPointerParameter constructor with an atomic bool pointer.
name | The name of the parameter. |
atomicValuePointer | Atomic pointer to the boolean value. |
|
overridevirtual |
Gets the current value of the parameter.
Implements switchboard::BoolParameter.
|
overridevirtual |
Sets a new value for the parameter.
newValue | The new value for the parameter. |
Implements switchboard::BoolParameter.