BoolCallbackParameter class. A boolean parameter class that wraps a getter and a setter methods. More...

#include <BoolCallbackParameter.hpp>

Inheritance diagram for switchboard::BoolCallbackParameter< T >:

Public Types
typedef bool(T::*)	BoolGetter() const

typedef void(T::*)	BoolSetter(bool)

Public Types inherited from switchboard::Parameter
enum class	Type { Float , Bool , Int , UInt , String }

Public Member Functions
	BoolCallbackParameter (const std::string &id, const std::string &name, const std::string &description, T *instance, BoolGetter getter, BoolSetter setter)
	BoolCallbackParameter constructor.

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
Protected Attributes inherited from switchboard::Parameter
Type	type

std::string	id

std::string	name

std::string	description

Detailed Description

template<typename T>
class switchboard::BoolCallbackParameter< T >

BoolCallbackParameter class. A boolean parameter class that wraps a getter and a setter methods.

Constructor & Destructor Documentation

template<typename T >

switchboard::BoolCallbackParameter< T >::BoolCallbackParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		T *	instance,
		BoolGetter	getter,
		BoolSetter	setter )

inline

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
instance	Pointer to the instance that the getter and setter methods belong to.
getter	The getter method for the parameter.
setter	The setter method for the parameter.

template<typename T >

bool switchboard::BoolCallbackParameter< T >::getValue ( ) const

inlineoverridevirtual

Gets the current value of the parameter.

template<typename T >

void switchboard::BoolCallbackParameter< T >::setValue ( const bool newValue )

inlineoverridevirtual

Sets a new value for the parameter.

Parameters

newValue The new value for the parameter.