Nextsim::ConfigurationHelp Class Reference

Collaboration diagram for Nextsim::ConfigurationHelp:

Public Types
enum class	ConfigType {   STRING , NUMERIC , INTEGER , MODULE ,   BOOLEAN }
typedef std::list< ConfigurationHelp >	OptionList
typedef std::map< std::string, OptionList >	HelpMap

Public Attributes
std::string	name
ConfigType	type
std::vector< std::string >	range
std::string	defaultValue
std::string	units
std::string	text

Detailed Description

Definition at line 18 of file ConfigurationHelp.hpp.

Member Typedef Documentation

HelpMap

std::map<std::string, OptionList> Nextsim::ConfigurationHelp::HelpMap

Definition at line 21 of file ConfigurationHelp.hpp.

OptionList

std::list<ConfigurationHelp> Nextsim::ConfigurationHelp::OptionList

Definition at line 20 of file ConfigurationHelp.hpp.

Member Enumeration Documentation

ConfigType

enum class Nextsim::ConfigurationHelp::ConfigType

strong

Definition at line 23 of file ConfigurationHelp.hpp.

Member Data Documentation

defaultValue

std::string Nextsim::ConfigurationHelp::defaultValue

Definition at line 28 of file ConfigurationHelp.hpp.

name

std::string Nextsim::ConfigurationHelp::name

Definition at line 25 of file ConfigurationHelp.hpp.

range

std::vector<std::string> Nextsim::ConfigurationHelp::range

Definition at line 27 of file ConfigurationHelp.hpp.

text

std::string Nextsim::ConfigurationHelp::text

Definition at line 30 of file ConfigurationHelp.hpp.

type

ConfigType Nextsim::ConfigurationHelp::type

Definition at line 26 of file ConfigurationHelp.hpp.

units

std::string Nextsim::ConfigurationHelp::units

Definition at line 29 of file ConfigurationHelp.hpp.

---

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

• /github/workspace/core/src/include/ConfigurationHelp.hpp