Switchboard SDK
Loading...
Searching...
No Matches
switchboard::UIntParameter Class Referenceabstract

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

#include <UIntParameter.hpp>

Inheritance diagram for switchboard::UIntParameter:
switchboard::UIntCallbackParameter< T > switchboard::UIntPointerParameter switchboard::UIntStoredParameter

Public Member Functions

 UIntParameter (const std::string &id, const std::string &name, const std::string &description)
 UIntParameter constructor.
 
virtual ~UIntParameter ()=default
 UIntParameter destructor.
 
virtual uint getValue () const =0
 Gets the current value of the parameter.
 
virtual void setValue (const uint newValue)=0
 Sets a new value for the parameter.
 
virtual uint getMinimumValue () const =0
 Gets the minimum value for the parameter.
 
virtual uint getMaximumValue () const =0
 Gets the maximum value for the parameter.
 
void setValue (std::any newValue) override
 
std::any getAnyValue () override
 

Detailed Description

UInt parameter abstract class. Intended to be subclassed.

Constructor & Destructor Documentation

◆ UIntParameter()

switchboard::UIntParameter::UIntParameter ( const std::string & id,
const std::string & name,
const std::string & description )

UIntParameter constructor.

Parameters
idThe unique identifier of the parameter.
nameThe name of the parameter.
descriptionThe description of the parameter.

Member Function Documentation

◆ getMaximumValue()

virtual uint switchboard::UIntParameter::getMaximumValue ( ) const
pure virtual

Gets the maximum value for the parameter.

Returns
The maximum value.

Implemented in switchboard::UIntCallbackParameter< T >, switchboard::UIntPointerParameter, and switchboard::UIntStoredParameter.

◆ getMinimumValue()

virtual uint switchboard::UIntParameter::getMinimumValue ( ) const
pure virtual

Gets the minimum value for the parameter.

Returns
The minimum value.

Implemented in switchboard::UIntCallbackParameter< T >, switchboard::UIntPointerParameter, and switchboard::UIntStoredParameter.

◆ getValue()

virtual uint switchboard::UIntParameter::getValue ( ) const
pure virtual

Gets the current value of the parameter.

Returns
The current value.

Implemented in switchboard::UIntCallbackParameter< T >, switchboard::UIntPointerParameter, and switchboard::UIntStoredParameter.

◆ setValue()

virtual void switchboard::UIntParameter::setValue ( const uint newValue)
pure virtual

Sets a new value for the parameter.

Parameters
newValueThe new value for the parameter.

Implemented in switchboard::UIntCallbackParameter< T >, switchboard::UIntPointerParameter, and switchboard::UIntStoredParameter.