Switchboard SDK
Loading...
Searching...
No Matches
switchboard::IntPointerParameter Class Reference

IntPointerParameter class. A int parameter class that wraps an external int variable. More...

#include <IntPointerParameter.hpp>

Inheritance diagram for switchboard::IntPointerParameter:
switchboard::IntParameter switchboard::Parameter

Public Member Functions

 IntPointerParameter (const std::string &id, const std::string &name, const std::string &description, int *valuePointer, const int minimumValue, const int maximumValue)
 IntPointerParameter constructor with a int pointer.
 
 IntPointerParameter (const std::string &id, const std::string &name, const std::string &description, std::atomic< int > *atomicValuePointer, const int minimumValue, const int maximumValue)
 IntPointerParameter constructor with an atomic int pointer.
 
int getValue () const override
 Gets the current value of the parameter.
 
void setValue (const int newValue) override
 Sets a new value for the parameter.
 
int getMinimumValue () const override
 Gets the minimum value for the parameter.
 
int getMaximumValue () const override
 Gets the maximum value for the parameter.
 
- Public Member Functions inherited from switchboard::IntParameter
 IntParameter (const std::string &id, const std::string &name, const std::string &description)
 IntParameter constructor.
 
virtual ~IntParameter ()=default
 IntParameter 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

IntPointerParameter class. A int parameter class that wraps an external int variable.

Constructor & Destructor Documentation

◆ IntPointerParameter() [1/2]

switchboard::IntPointerParameter::IntPointerParameter ( const std::string & id,
const std::string & name,
const std::string & description,
int * valuePointer,
const int minimumValue,
const int maximumValue )

IntPointerParameter constructor with a int pointer.

Parameters
idThe unique identifier of the parameter.
nameThe name of the parameter.
descriptionThe description of the parameter.
valuePointerPointer to the boolean value.
minimumValueMinimum value for the parameter.
maximumValueMaximum value for the parameter.

◆ IntPointerParameter() [2/2]

switchboard::IntPointerParameter::IntPointerParameter ( const std::string & id,
const std::string & name,
const std::string & description,
std::atomic< int > * atomicValuePointer,
const int minimumValue,
const int maximumValue )

IntPointerParameter constructor with an atomic int pointer.

Parameters
nameThe name of the parameter.
atomicValuePointerAtomic pointer to the boolean value.
minimumValueMinimum value for the parameter.
maximumValueMaximum value for the parameter.

Member Function Documentation

◆ getMaximumValue()

int switchboard::IntPointerParameter::getMaximumValue ( ) const
overridevirtual

Gets the maximum value for the parameter.

Returns
The maximum value.

Implements switchboard::IntParameter.

◆ getMinimumValue()

int switchboard::IntPointerParameter::getMinimumValue ( ) const
overridevirtual

Gets the minimum value for the parameter.

Returns
The minimum value.

Implements switchboard::IntParameter.

◆ getValue()

int switchboard::IntPointerParameter::getValue ( ) const
overridevirtual

Gets the current value of the parameter.

Returns
The current value.

Implements switchboard::IntParameter.

◆ setValue()

void switchboard::IntPointerParameter::setValue ( const int newValue)
overridevirtual

Sets a new value for the parameter.

Parameters
newValueThe new value for the parameter.

Implements switchboard::IntParameter.