iRoCS Toolbox  1.1.0
Static Public Member Functions
svt::HelpExtractor< LIST > Class Template Reference

The HelpExtractor class contains methods to extract the ParamInfo's and name() / Descriptions form all elements in a TList. More...

#include <HelpExtractor.hh>

Collaboration diagram for svt::HelpExtractor< LIST >:

Static Public Member Functions

static void collectParamInfos (std::vector< ParamInfo > &help)
 recursive getParamInfos() for TList items More...
 
static ParamInfo createParamInfoFromNamesDescriptions (std::string longKey, std::string shortKey)
 recursive creating of ParamInfo - Alternatives from name() and description() methods from all elements in given Type list. More...
 
static void getNamesDescriptions (ParamInfo &help)
 recursive extract name() and description() for TList items More...
 

Detailed Description

template<typename LIST>
class svt::HelpExtractor< LIST >

The HelpExtractor class contains methods to extract the ParamInfo's and name() / Descriptions form all elements in a TList.

Parameters
LISTa TypeList with classes, that provide a getParamInfos() method or name() and description() methods

Definition at line 79 of file HelpExtractor.hh.

Member Function Documentation

◆ collectParamInfos()

template<typename LIST>
static void svt::HelpExtractor< LIST >::collectParamInfos ( std::vector< ParamInfo > &  help)
inlinestatic

recursive getParamInfos() for TList items

Parameters
help(in/out) add Help texts for parameters of current and following TList items to given map

Definition at line 91 of file HelpExtractor.hh.

Referenced by svt::HelpExtractor< svt::TTList< X, Y > >::collectParamInfos().

◆ createParamInfoFromNamesDescriptions()

template<typename LIST>
static ParamInfo svt::HelpExtractor< LIST >::createParamInfoFromNamesDescriptions ( std::string  longKey,
std::string  shortKey 
)
inlinestatic

recursive creating of ParamInfo - Alternatives from name() and description() methods from all elements in given Type list.

Parameters
longKeylongKey entry for each created ParamInfo
shortKeyshortKey entry for each created ParamInfo
Exceptions

Definition at line 118 of file HelpExtractor.hh.

◆ getNamesDescriptions()

template<typename LIST>
static void svt::HelpExtractor< LIST >::getNamesDescriptions ( ParamInfo help)
inlinestatic

recursive extract name() and description() for TList items

Parameters
help(in/out) add name() and description() of current TList item to given ParamInfo using addAlternative()

Definition at line 138 of file HelpExtractor.hh.

Referenced by svt::HelpExtractor< LIST >::createParamInfoFromNamesDescriptions(), svt::HelpExtractor< svt::TTList< X, Y > >::createParamInfoFromNamesDescriptions(), svt::HelpExtractor< svt::TTList< X, Y > >::getNamesDescriptions(), and svt::PrettyOptionPrinter::setIndentColumn().


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