iRoCS Toolbox  1.1.0
Public Member Functions
svt::ParamInfo Class Reference

The ParamInfo class contains informations about one parameter like key, help text, guiHints etc. More...

#include <ParamInfo.hh>

Collaboration diagram for svt::ParamInfo:

Public Member Functions

 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 AlternativeHelpalternatives (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
 

Detailed Description

The ParamInfo class contains informations about one parameter like key, help text, guiHints etc.

(description)

Definition at line 82 of file ParamInfo.hh.

Constructor & Destructor Documentation

◆ 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.

Member Function Documentation

◆ 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

Definition at line 131 of file ParamInfo.hh.

◆ longKey()

const std::string& svt::ParamInfo::longKey ( ) const
inline

Definition at line 137 of file ParamInfo.hh.

◆ shortKey()

const std::string& svt::ParamInfo::shortKey ( ) const
inline

Definition at line 140 of file ParamInfo.hh.

◆ nAlternatives()

size_t svt::ParamInfo::nAlternatives ( ) const
inline

Definition at line 143 of file ParamInfo.hh.

◆ alternatives()

const AlternativeHelp& svt::ParamInfo::alternatives ( size_t  index) const
inline

Definition at line 148 of file ParamInfo.hh.

◆ guiHints()

const std::map<std::string, std::string>& svt::ParamInfo::guiHints ( ) const
inline

Definition at line 154 of file ParamInfo.hh.

◆ operator<()

bool svt::ParamInfo::operator< ( const ParamInfo rhs) const
inline

Definition at line 159 of file ParamInfo.hh.

◆ operator==()

bool svt::ParamInfo::operator== ( const ParamInfo rhs) const
inline

Definition at line 177 of file ParamInfo.hh.

◆ debugPrint()

void svt::ParamInfo::debugPrint ( std::ostream &  os) const
inline

Definition at line 191 of file ParamInfo.hh.


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