Describes a parameter with a type, default value, whether or not is it mandatory and a help string describing what this parameter should be used for.
More...
#include <WithParameter.h>
Detailed Description
Describes a parameter with a type, default value, whether or not is it mandatory and a help string describing what this parameter should be used for.
Constructor & Destructor Documentation
tlp::ParameterDescription::ParameterDescription |
( |
| ) |
|
|
inline |
tlp::ParameterDescription::ParameterDescription |
( |
const std::string & |
name, |
|
|
const std::string & |
type, |
|
|
const std::string & |
help, |
|
|
const std::string & |
defaultValue, |
|
|
bool |
mandatory, |
|
|
ParameterDirection |
direction |
|
) |
| |
|
inline |
Member Function Documentation
const std::string& tlp::ParameterDescription::getDefaultValue |
( |
| ) |
const |
|
inline |
const std::string& tlp::ParameterDescription::getHelp |
( |
| ) |
const |
|
inline |
const std::string& tlp::ParameterDescription::getName |
( |
| ) |
const |
|
inline |
const std::string& tlp::ParameterDescription::getTypeName |
( |
| ) |
const |
|
inline |
bool tlp::ParameterDescription::isMandatory |
( |
| ) |
|
|
inline |
void tlp::ParameterDescription::setDefaultValue |
( |
const std::string & |
defVal | ) |
|
|
inline |