switchboard::BoolPointerParameter Class Reference

BoolPointerParameter class. A boolean parameter class that wraps an external bool variable. More...

#include <BoolPointerParameter.hpp>

Inheritance diagram for switchboard::BoolPointerParameter:

Public Member Functions
	BoolPointerParameter (const std::string &id, const std::string &name, const std::string &description, bool *valuePointer)
	BoolPointerParameter constructor with a bool pointer.
	BoolPointerParameter (const std::string &id, const std::string &name, const std::string &description, 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 &id, const std::string &name, const std::string &description)
	BoolParameter constructor.
virtual	~BoolParameter ()=default
	BoolParameter 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

BoolPointerParameter class. A boolean parameter class that wraps an external bool variable.

Constructor & Destructor Documentation

BoolPointerParameter() [1/2]

switchboard::BoolPointerParameter::BoolPointerParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		bool *	valuePointer )

BoolPointerParameter constructor with a bool pointer.

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
valuePointer	Pointer to the boolean value.

BoolPointerParameter() [2/2]

switchboard::BoolPointerParameter::BoolPointerParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		std::atomic< bool > *	atomicValuePointer )

BoolPointerParameter constructor with an atomic bool pointer.

Parameters

name	The name of the parameter.
atomicValuePointer	Atomic pointer to the boolean value.

Member Function Documentation

getValue()

bool switchboard::BoolPointerParameter::getValue ( ) const

overridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::BoolParameter.

setValue()

void switchboard::BoolPointerParameter::setValue ( const bool newValue )

overridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::BoolParameter.