iRoCS Toolbox  1.1.0
Static Public Member Functions
svt::HelpExtractor< svt::TTList< X, Y > > Struct Template Reference

#include <HelpExtractor.hh>

Collaboration diagram for svt::HelpExtractor< svt::TTList< X, Y > >:

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<template< typename > class X, typename Y>
struct svt::HelpExtractor< svt::TTList< X, Y > >

Definition at line 184 of file HelpExtractor.hh.

Member Function Documentation

◆ collectParamInfos()

template<template< typename > class X, typename Y >
static void svt::HelpExtractor< svt::TTList< X, Y > >::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 196 of file HelpExtractor.hh.

◆ createParamInfoFromNamesDescriptions()

template<template< typename > class X, typename Y >
static ParamInfo svt::HelpExtractor< svt::TTList< X, Y > >::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 224 of file HelpExtractor.hh.

◆ getNamesDescriptions()

template<template< typename > class X, typename Y >
static void svt::HelpExtractor< svt::TTList< X, Y > >::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 242 of file HelpExtractor.hh.


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