netxsimdg
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | List of all members
Nextsim::ConfigurationHelpPrinter Class Reference
Collaboration diagram for Nextsim::ConfigurationHelpPrinter:
Collaboration graph

Public Types

enum class  Output { ANSI , MARKDOWN }
 
typedef ConfigurationHelp::ConfigType ConfigType
 

Static Public Member Functions

static void setOutput (Output out)
 
static std::ostream & print (std::ostream &os, const ConfigurationHelp::HelpMap &map, const std::string &target)
 
static std::ostream & print (std::ostream &os, const ConfigurationHelp &help)
 

Static Public Attributes

static const std::string allStr = "all"
 
static const std::string availStr = "avail"
 

Static Protected Member Functions

static std::ostream & printString (std::ostream &os, const ConfigurationHelp &help)
 
static std::ostream & printNumeric (std::ostream &os, const ConfigurationHelp &help)
 
static std::ostream & printInteger (std::ostream &os, const ConfigurationHelp &help)
 
static std::ostream & printModule (std::ostream &os, const ConfigurationHelp &help)
 
static std::ostream & printBoolean (std::ostream &os, const ConfigurationHelp &help)
 

Detailed Description

Definition at line 20 of file ConfigurationHelpPrinter.hpp.

Member Typedef Documentation

◆ ConfigType

ConfigurationHelp::ConfigType Nextsim::ConfigurationHelpPrinter::ConfigType

Definition at line 22 of file ConfigurationHelpPrinter.hpp.

Member Enumeration Documentation

◆ Output

enum class Nextsim::ConfigurationHelpPrinter::Output
strong

Definition at line 24 of file ConfigurationHelpPrinter.hpp.

Member Function Documentation

◆ print() [1/2]

std::ostream & Nextsim::ConfigurationHelpPrinter::print ( std::ostream & os,
const ConfigurationHelp & help )
static

Definition at line 98 of file ConfigurationHelpPrinter.cpp.

◆ print() [2/2]

std::ostream & Nextsim::ConfigurationHelpPrinter::print ( std::ostream & os,
const ConfigurationHelp::HelpMap & map,
const std::string & target )
static

Definition at line 36 of file ConfigurationHelpPrinter.cpp.

◆ printBoolean()

std::ostream & Nextsim::ConfigurationHelpPrinter::printBoolean ( std::ostream & os,
const ConfigurationHelp & help )
staticprotected

Definition at line 176 of file ConfigurationHelpPrinter.cpp.

◆ printInteger()

std::ostream & Nextsim::ConfigurationHelpPrinter::printInteger ( std::ostream & os,
const ConfigurationHelp & help )
staticprotected

Definition at line 147 of file ConfigurationHelpPrinter.cpp.

◆ printModule()

std::ostream & Nextsim::ConfigurationHelpPrinter::printModule ( std::ostream & os,
const ConfigurationHelp & help )
staticprotected

Definition at line 161 of file ConfigurationHelpPrinter.cpp.

◆ printNumeric()

std::ostream & Nextsim::ConfigurationHelpPrinter::printNumeric ( std::ostream & os,
const ConfigurationHelp & help )
staticprotected

Definition at line 133 of file ConfigurationHelpPrinter.cpp.

◆ printString()

std::ostream & Nextsim::ConfigurationHelpPrinter::printString ( std::ostream & os,
const ConfigurationHelp & help )
staticprotected

Definition at line 121 of file ConfigurationHelpPrinter.cpp.

◆ setOutput()

void Nextsim::ConfigurationHelpPrinter::setOutput ( Output out)
static

Definition at line 191 of file ConfigurationHelpPrinter.cpp.

Member Data Documentation

◆ allStr

const std::string Nextsim::ConfigurationHelpPrinter::allStr = "all"
static

Definition at line 29 of file ConfigurationHelpPrinter.hpp.

◆ availStr

const std::string Nextsim::ConfigurationHelpPrinter::availStr = "avail"
static

Definition at line 30 of file ConfigurationHelpPrinter.hpp.

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