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 name, 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 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

Detailed Description

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

Constructor & Destructor Documentation

BoolStoredParameter()

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

BoolStoredParameter constructor with a default value.

Parameters

name	The name 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.