switchboard::UIntStoredParameter Class Reference

UIntStoredParameter class. A uint parameter class that contains an uint variable. More...

#include <UIntStoredParameter.hpp>

Inheritance diagram for switchboard::UIntStoredParameter:

Public Member Functions
WASM	UIntStoredParameter (const std::string &id, const std::string &name, const std::string &description, const uint defaultValue, const uint minimumValue, const uint maximumValue)
	UIntStoredParameter constructor with a default value.
WASM uint	getValue () const override
	Gets the current value of the parameter.
WASM void	setValue (const uint newValue) override
	Sets a new value for the parameter.
WASM uint	getMinimumValue () const override
	Gets the minimum value for the parameter.
WASM uint	getMaximumValue () const override
	Gets the maximum value for the parameter.
Public Member Functions inherited from switchboard::UIntParameter
	UIntParameter (const std::string &id, const std::string &name, const std::string &description)
	UIntParameter constructor.
virtual	~UIntParameter ()=default
	UIntParameter 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

UIntStoredParameter class. A uint parameter class that contains an uint variable.

Constructor & Destructor Documentation

UIntStoredParameter()

switchboard::UIntStoredParameter::UIntStoredParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		const uint	defaultValue,
		const uint	minimumValue,
		const uint	maximumValue )

UIntStoredParameter 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 uint value.
minimumValue	Minimum value for the parameter.
maximumValue	Maximum value for the parameter.

Member Function Documentation

getMaximumValue()

uint switchboard::UIntStoredParameter::getMaximumValue ( ) const

overridevirtual

Gets the maximum value for the parameter.

Returns

The maximum value.

Implements switchboard::UIntParameter.

getMinimumValue()

uint switchboard::UIntStoredParameter::getMinimumValue ( ) const

overridevirtual

Gets the minimum value for the parameter.

Returns

The minimum value.

Implements switchboard::UIntParameter.

getValue()

uint switchboard::UIntStoredParameter::getValue ( ) const

overridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::UIntParameter.

setValue()

void switchboard::UIntStoredParameter::setValue ( const uint newValue )

overridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::UIntParameter.