switchboard::BoolCallbackParameter< T > Class Template Reference

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 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
std::any	getAnyValue () override

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

BoolCallbackParameter()

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

BoolCallbackParameter constructor.

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.

Member Function Documentation

getValue()

template<typename T>

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

inlineoverridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::BoolParameter.

setValue()

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.

Implements switchboard::BoolParameter.