asl::ApplicationParametersManager Class Reference

#include <aslParametersManager.h>

Inheritance diagram for asl::ApplicationParametersManager:

Public Member Functions
	ApplicationParametersManager (const char *applicationName_, const char *applicationVersion_)
void	load (int argc, char *argv[])
	ApplicationParametersManager (const char *applicationName_, const char *applicationVersion_)
void	load (int argc, char *argv[])
Public Member Functions inherited from asl::ParametersManager
	ParametersManager ()
	~ParametersManager ()
void	enable ()
	Enables parameter loader. More...
template<typename T >
void	add (UValue< T > parameter, const char *key, const char *description, const char *units)
	Adds a Parameter to ParametersManager. More...
template<typename T >
void	add (UValue< std::map< std::string, T >> parameter, const char *key, const char *description, const char *units)
	Adds a group of parameters with common prefix to ParametersManager. More...
template<typename T >
void	add (UValue< T > parameter, T defaultValue, const char *key, const char *description, const char *units)
	Adds a Parameter with a default value to ParametersManager. More...
template<typename T >
void	addPrefix (const std::string prefix, std::shared_ptr< std::map< std::string, T >> destinationMap)
void	load (std::string paramFile)
std::string	getDir ()
	ParametersManager ()
	~ParametersManager ()
void	enable ()
	Enables parameter loader. More...
template<typename T >
void	add (UValue< T > parameter, const char *key, const char *description, const char *units)
	Adds a Parameter to ParametersManager. More...
template<typename T >
void	add (UValue< std::map< std::string, T >> parameter, const char *key, const char *description, const char *units)
	Adds a group of parameters with common prefix to ParametersManager. More...
template<typename T >
void	add (UValue< T > parameter, T defaultValue, const char *key, const char *description, const char *units)
	Adds a Parameter with a default value to ParametersManager. More...
template<typename T >
void	addPrefix (const std::string prefix, std::shared_ptr< std::map< std::string, T >> destinationMap)
void	load (std::string paramFile)
std::string	getDir ()

Additional Inherited Members
Static Public Attributes inherited from asl::ParametersManager
static ParametersManager *	current
Protected Member Functions inherited from asl::ParametersManager
void	populateMaps (boost::program_options::variables_map &vm)
void	writeParametersFile (const std::string fileName)
void	populateMaps (boost::program_options::variables_map &vm)
void	writeParametersFile (const std::string fileName)
Protected Attributes inherited from asl::ParametersManager
boost::program_options::options_description	parametersOptions
std::string	parametersFileDirectory
std::vector< std::shared_ptr< PrefixStore > >	prefixes
std::string	parametersFileStr
	Content of the parameters file. More...

Detailed Description

This class inherits ParametersManager class and thus also automatically accomodates newly created Parameters and then can load them from a parameters file and/or command line. It silently includes two parameters - platform and device that determine the hardware the application will run on. It has to be declared before declaring all the parameters it will manage!

Examples:

acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 156 of file aslParametersManager.h.

Constructor & Destructor Documentation

asl::ApplicationParametersManager::ApplicationParametersManager	(	const char *	applicationName_,
		const char *	applicationVersion_
	)

asl::ApplicationParametersManager::ApplicationParametersManager	(	const char *	applicationName_,
		const char *	applicationVersion_
	)

Member Function Documentation

void asl::ApplicationParametersManager::load	(	int	argc,
		char *	argv[]
	)

Loads all previously declared parameters from command line and/or parameters file (provided through command line)

Examples:

acousticWaves.cc, bus_wind.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flowRotatingCylinders.cc, jumpingBox.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

void asl::ApplicationParametersManager::load	(	int	argc,
		char *	argv[]
	)

Loads all previously declared parameters from command line and/or parameters file (provided through command line)

---

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

• /build/asl-cIsmox/asl-0.1.6/debian/tmp/usr/include/ASL/utilities/aslParametersManager.h