Parameter Class Reference

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarpDeviceParamParserGenerator/parameter.h>

Public Member Functions
void	setFullyScopedParamName (std::string fullyScopedParamName)
std::string	getFullGroupOnlyName () const
std::string	getFullParamName () const
std::string	getParamOnly () const
std::string	getFullParamVariable () const
std::deque< std::string >	getListOfGroups () const

Public Attributes
std::string	type
std::string	units
std::string	defaultValue
bool	required = false
std::string	description
std::string	notes
std::string	optional_variable_name

Detailed Description

Definition at line 19 of file parameter.h.

Member Function Documentation

getFullGroupOnlyName()

std::string Parameter::getFullGroupOnlyName

(

)

const

Definition at line 41 of file parameter.cpp.

getFullParamName()

std::string Parameter::getFullParamName

(

)

const

Definition at line 53 of file parameter.cpp.

getFullParamVariable()

std::string Parameter::getFullParamVariable

(

)

const

Definition at line 76 of file parameter.cpp.

getListOfGroups()

std::deque< std::string > Parameter::getListOfGroups

(

)

const

Definition at line 94 of file parameter.cpp.

getParamOnly()

std::string Parameter::getParamOnly

(

)

const

Definition at line 89 of file parameter.cpp.

setFullyScopedParamName()

void Parameter::setFullyScopedParamName

(

std::string

fullyScopedParamName

)

Definition at line 21 of file parameter.cpp.

Member Data Documentation

defaultValue

std::string Parameter::defaultValue

Definition at line 29 of file parameter.h.

description

std::string Parameter::description

Definition at line 31 of file parameter.h.

notes

std::string Parameter::notes

Definition at line 32 of file parameter.h.

optional_variable_name

std::string Parameter::optional_variable_name

Definition at line 33 of file parameter.h.

required

bool Parameter::required = false

Definition at line 30 of file parameter.h.

type

std::string Parameter::type

Definition at line 27 of file parameter.h.

units

std::string Parameter::units

Definition at line 28 of file parameter.h.

---

The documentation for this class was generated from the following files:

• src/commands/yarpDeviceParamParserGenerator/parameter.h
• src/commands/yarpDeviceParamParserGenerator/parameter.cpp