Tulip
4.6.0
Better Visualization Through Research
|
#include <WithParameter.h>
Public Member Functions | |
ParameterDescription (const std::string &name, const std::string &type, const std::string &help, const std::string &defaultValue, bool mandatory, ParameterDirection direction) | |
const std::string & | getDefaultValue () const |
ParameterDirection | getDirection () const |
const std::string & | getHelp () const |
const std::string & | getName () const |
const std::string & | getTypeName () const |
bool | isMandatory () const |
void | setDefaultValue (const std::string &defVal) |
void | setDirection (ParameterDirection dir) |
Describes a plugin's parameter.
A plugin parameter consists of the following information:
Definition at line 66 of file WithParameter.h.
const std::string& tlp::ParameterDescription::getDefaultValue | ( | ) | const [inline] |
Definition at line 103 of file WithParameter.h.
ParameterDirection tlp::ParameterDescription::getDirection | ( | ) | const [inline] |
Definition at line 121 of file WithParameter.h.
const std::string& tlp::ParameterDescription::getHelp | ( | ) | const [inline] |
Definition at line 97 of file WithParameter.h.
const std::string& tlp::ParameterDescription::getName | ( | ) | const [inline] |
Definition at line 85 of file WithParameter.h.
const std::string& tlp::ParameterDescription::getTypeName | ( | ) | const [inline] |
Definition at line 91 of file WithParameter.h.
bool tlp::ParameterDescription::isMandatory | ( | ) | const [inline] |
Definition at line 115 of file WithParameter.h.
void tlp::ParameterDescription::setDefaultValue | ( | const std::string & | defVal | ) | [inline] |
Set the parameter's default value.
Definition at line 109 of file WithParameter.h.
void tlp::ParameterDescription::setDirection | ( | ParameterDirection | dir | ) | [inline] |
Definition at line 127 of file WithParameter.h.