switchboard::FloatParameter Class Reference

Float parameter abstract class. Intended to be subclassed. More...

#include <FloatParameter.hpp>

Inheritance diagram for switchboard::FloatParameter:

Public Member Functions
	FloatParameter (const std::string name)
	FloatParameter constructor.
virtual	~FloatParameter ()=default
	FloatParameter destructor.
virtual float	getValue () const =0
	Gets the current value of the parameter.
virtual void	setValue (const float newValue)=0
	Sets a new value for the parameter.
virtual float	getMinimumValue () const =0
	Gets the minimum value for the parameter.
virtual float	getMaximumValue () const =0
	Gets the maximum value for the parameter.
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

Float parameter abstract class. Intended to be subclassed.

Constructor & Destructor Documentation

FloatParameter()

switchboard::FloatParameter::FloatParameter

(

const std::string

name

)

FloatParameter constructor.

Parameters

name	The name of the parameter.

Member Function Documentation

getMaximumValue()

virtual float switchboard::FloatParameter::getMaximumValue ( ) const

pure virtual

Gets the maximum value for the parameter.

Returns

The maximum value.

Implemented in switchboard::FloatCallbackParameter< T >, switchboard::FloatPointerParameter, and switchboard::FloatStoredParameter.

getMinimumValue()

virtual float switchboard::FloatParameter::getMinimumValue ( ) const

pure virtual

Gets the minimum value for the parameter.

Returns

The minimum value.

Implemented in switchboard::FloatCallbackParameter< T >, switchboard::FloatPointerParameter, and switchboard::FloatStoredParameter.

getValue()

virtual float switchboard::FloatParameter::getValue ( ) const

pure virtual

Gets the current value of the parameter.

Returns

The current value.

Implemented in switchboard::FloatCallbackParameter< T >, switchboard::FloatPointerParameter, and switchboard::FloatStoredParameter.

setValue()

virtual void switchboard::FloatParameter::setValue ( const float newValue )

pure virtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implemented in switchboard::FloatCallbackParameter< T >, switchboard::FloatPointerParameter, and switchboard::FloatStoredParameter.