switchboard::BoolStoredParameter Class Reference

BoolStoredParameter class. A bool parameter class that contains an bool variable. More...

#include <BoolStoredParameter.hpp>

Inheritance diagram for switchboard::BoolStoredParameter:

Public Member Functions
WASM	BoolStoredParameter (const std::string &id, const std::string &name, const std::string &description, const bool defaultValue)
	BoolStoredParameter constructor with a default value.
WASM bool	getValue () const override
	Gets the current value of the parameter.
WASM 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

BoolStoredParameter class. A bool parameter class that contains an bool variable.

Constructor & Destructor Documentation

BoolStoredParameter()

switchboard::BoolStoredParameter::BoolStoredParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		const bool	defaultValue )

BoolStoredParameter constructor with a default value.

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
defaultValue	Default bool value.

Member Function Documentation

getValue()

bool switchboard::BoolStoredParameter::getValue ( ) const

overridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::BoolParameter.

setValue()

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

overridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::BoolParameter.