SnowpackConfig Class Reference

#include <SnowpackConfig.h>

Public Member Functions
	SnowpackConfig (const std::string &i_filename)
	Main constructor. The file is parsed and a key/value map object is internally created furthermore all missing key value pairs needed for Snowpack operation are added.
	SnowpackConfig (const mio::Config &i_cfg)
void	checkStandaloneKeys (const std::string &mode)
	Check the consistency of some keys when Snowpack is run standalone.
void	addStandaloneKeys (const std::string &mode)
	Add some keys when Snowpack is run standalone, based on some other keys.

Constructor & Destructor Documentation

SnowpackConfig() [1/2]

SnowpackConfig::SnowpackConfig

(

const std::string &

i_filename

)

Main constructor. The file is parsed and a key/value map object is internally created furthermore all missing key value pairs needed for Snowpack operation are added.

Parameters

[in]

i_filename

string representing the absolute filename of the key/value file

SnowpackConfig() [2/2]

SnowpackConfig::SnowpackConfig

(

const mio::Config &

i_cfg

)

Member Function Documentation

addStandaloneKeys()

void SnowpackConfig::addStandaloneKeys

(

const std::string &

mode

)

Add some keys when Snowpack is run standalone, based on some other keys.

When running Snowpack standalone, we know better what to expect and so we can enforce some configuration keys that will be necessary. For example, computing the necessary averages in order to run the DETECT_GRASS filter. Or to properly filter the forcings when running in polar configuration.

Parameters

[in]

mode

Snowpack runnning mode (operational or research)

checkStandaloneKeys()

void SnowpackConfig::checkStandaloneKeys

(

const std::string &

mode

)

Check the consistency of some keys when Snowpack is run standalone.

When running Snowpack standalone, we know better what to expect and so we can check that the configuration makes sense and warn if user if not. For example, that liquid precipitation re-accumulation is properly done.

Parameters

[in]

mode

Snowpack runnning mode (operational or research)

---

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

• SnowpackConfig.h
• SnowpackConfig.cc