The ParamInfo class contains informations about one parameter like key, help text, guiHints etc.
More...
#include <ParamInfo.hh>
|
| ParamInfo (std::string longKey, std::string shortKey, std::string value, std::string helpText) |
| Construtor for keys, that need only one helpText (e.g. More...
|
|
| ParamInfo (std::string longKey, std::string shortKey) |
| Construtor for keys, that need multiple alternative values, e.g. More...
|
|
void | addAlternative (const std::string &value, const std::string &helpText) |
|
void | addGuiHint (const std::string &key, const std::string &value) |
|
const AlternativeHelp & | alternatives (size_t index) const |
|
void | debugPrint (std::ostream &os) const |
|
const std::map< std::string, std::string > & | guiHints () const |
|
const std::string & | longKey () const |
|
size_t | nAlternatives () const |
|
bool | operator< (const ParamInfo &rhs) const |
|
bool | operator== (const ParamInfo &rhs) const |
|
const std::string & | shortKey () const |
|
The ParamInfo class contains informations about one parameter like key, help text, guiHints etc.
(description)
Definition at line 82 of file ParamInfo.hh.
◆ ParamInfo() [1/2]
svt::ParamInfo::ParamInfo |
( |
std::string |
longKey, |
|
|
std::string |
shortKey, |
|
|
std::string |
value, |
|
|
std::string |
helpText |
|
) |
| |
|
inline |
Construtor for keys, that need only one helpText (e.g.
"gamma")
- Parameters
-
Definition at line 98 of file ParamInfo.hh.
◆ ParamInfo() [2/2]
svt::ParamInfo::ParamInfo |
( |
std::string |
longKey, |
|
|
std::string |
shortKey |
|
) |
| |
|
inline |
Construtor for keys, that need multiple alternative values, e.g.
"kernel_type", where value may be "linear", "rbf", "poly", etc. Add the alternatives with addAlternative() method alter
- Parameters
-
Definition at line 120 of file ParamInfo.hh.
◆ addAlternative()
void svt::ParamInfo::addAlternative |
( |
const std::string & |
value, |
|
|
const std::string & |
helpText |
|
) |
| |
|
inline |
◆ addGuiHint()
void svt::ParamInfo::addGuiHint |
( |
const std::string & |
key, |
|
|
const std::string & |
value |
|
) |
| |
|
inline |
◆ longKey()
const std::string& svt::ParamInfo::longKey |
( |
| ) |
const |
|
inline |
◆ shortKey()
const std::string& svt::ParamInfo::shortKey |
( |
| ) |
const |
|
inline |
◆ nAlternatives()
size_t svt::ParamInfo::nAlternatives |
( |
| ) |
const |
|
inline |
◆ alternatives()
◆ guiHints()
const std::map<std::string, std::string>& svt::ParamInfo::guiHints |
( |
| ) |
const |
|
inline |
◆ operator<()
bool svt::ParamInfo::operator< |
( |
const ParamInfo & |
rhs | ) |
const |
|
inline |
◆ operator==()
bool svt::ParamInfo::operator== |
( |
const ParamInfo & |
rhs | ) |
const |
|
inline |
◆ debugPrint()
void svt::ParamInfo::debugPrint |
( |
std::ostream & |
os | ) |
const |
|
inline |
The documentation for this class was generated from the following file: