Config2 Class Reference

Inheritance diagram for Config2:

Collaboration diagram for Config2:

Public Types
enum	{ VALUE_KEY , NAME_KEY }
Public Types inherited from Nextsim::Configured< Config2 >
typedef ConfigurationHelp::HelpMap	HelpMap
using	ConfigType

Public Member Functions
int	getValue ()
std::string	getName ()
void	configure () override
	The configuration function.
Public Member Functions inherited from Nextsim::Configured< Config2 >
const std::map< int, std::string >	keyMap
const std::map< int, std::string >	keyMap
const std::map< int, std::string >	keyMap
const std::map< int, std::string >	keyMap
virtual ConfigMap	getConfiguration () const
	Returns the current configuration of the object.
Public Member Functions inherited from Nextsim::ConfiguredBase

Additional Inherited Members
Static Public Member Functions inherited from Nextsim::Configured< Config2 >
static T	getConfiguration (const std::string &name, const T &defaultValue)
	Gets the value of the configuration with a given name from the default Configurator.
static void	tryConfigure (T &ref)
	Template function for conditionally configuring references.
static void	tryConfigure (T *ptr)
	Template function for conditionally configuring classes via a pointer.
static ConfigMap	tryGetConfiguration (T &ref)
	Template function for conditionally retrieving class configuration via a reference.
static ConfigMap	tryGetConfiguration (T *ptr)
	Template function for conditionally retrieving class configuration via a pointer.
static HelpMap &	getHelpText (HelpMap &map, bool getAll)
	Gets the text to be printed as the help text for this configuration.
static HelpMap &	getHelpRecursive (HelpMap &map, bool getAll)
	Gets the configuration help text for the current class as well as any classes used herein.
static void	clearConfigurationMap ()
	Clear the configuration map. Usually used only in test suites.
Static Public Attributes inherited from Nextsim::Configured< Config2 >
static const std::map< int, std::string >	keyMap
	A per-class static map to provide compile-time checking of configuration keys.
Protected Member Functions inherited from Nextsim::Configured< Config2 >
void	addOption (const std::string &name, const T &defaultValue)
	Adds an option to the per-class option map.
T	retrieveValue (const std::string &name)
	Retrieves a configured value of a single option.

Detailed Description

Definition at line 46 of file Configurator_test.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Definition at line 48 of file Configurator_test.cpp.

Constructor & Destructor Documentation

Config2()

Config2::Config2

(

)

Definition at line 70 of file Configurator_test.cpp.

Member Function Documentation

configure()

void Config2::configure ( )

overridevirtual

The configuration function.

Implements Nextsim::Configured< Config2 >.

Definition at line 77 of file Configurator_test.cpp.

Here is the call graph for this function:

getName()

std::string Config2::getName ( )

inline

Definition at line 55 of file Configurator_test.cpp.

getValue()

int Config2::getValue ( )

inline

Definition at line 54 of file Configurator_test.cpp.

---

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

• /github/workspace/core/test/Configurator_test.cpp