switchboard::StringPointerParameter Class Reference

StringPointerParameter class. More...

#include <StringPointerParameter.hpp>

Inheritance diagram for switchboard::StringPointerParameter:

Public Member Functions
	StringPointerParameter (const std::string &id, const std::string &name, const std::string &description, std::string *valuePointer)
	StringPointerParameter constructor with a string pointer.
std::string	getValue () const override
	Gets the current value of the parameter.
void	setValue (const std::string newValue) override
	Sets a new value for the parameter.
Public Member Functions inherited from switchboard::StringParameter
	StringParameter (const std::string &id, const std::string &name, const std::string &description)
	StringParameter constructor.
virtual	~StringParameter ()=default
	StringParameter destructor.
void	setValue (std::any newValue) override
std::any	getAnyValue () override

Detailed Description

StringPointerParameter class.

Constructor & Destructor Documentation

StringPointerParameter()

switchboard::StringPointerParameter::StringPointerParameter	(	const std::string &	id,
		const std::string &	name,
		const std::string &	description,
		std::string *	valuePointer )

StringPointerParameter constructor with a string pointer.

Parameters

id	The unique identifier of the parameter.
name	The name of the parameter.
description	The description of the parameter.
valuePointer	Pointer to the string value.

Member Function Documentation

getValue()

std::string switchboard::StringPointerParameter::getValue ( ) const

overridevirtual

Gets the current value of the parameter.

Returns

The current value.

Implements switchboard::StringParameter.

setValue()

void switchboard::StringPointerParameter::setValue ( const std::string newValue )

overridevirtual

Sets a new value for the parameter.

Parameters

newValue

The new value for the parameter.

Implements switchboard::StringParameter.