realization::config::Forcing Struct Reference

Structure for holding forcing configuration information. More...

#include <forcing.hpp>

Collaboration diagram for realization::config::Forcing:

Public Member Functions
	Forcing ()
	Construct a new, empty Forcing object.
	Forcing (const boost::property_tree::ptree &tree)
	Construct a new Forcing object from a property_tree.
bool	has_key (const std::string &key) const
	Test if a particualr forcing parameter exists.

Public Attributes
geojson::PropertyMap	parameters
	key -> Property mapping for forcing parameters

Detailed Description

Structure for holding forcing configuration information.

Constructor & Destructor Documentation

Forcing() [1/2]

realization::config::Forcing::Forcing ( )

inline

Construct a new, empty Forcing object.

Forcing() [2/2]

realization::config::Forcing::Forcing ( const boost::property_tree::ptree & tree )

inline

Construct a new Forcing object from a property_tree.

Parameters

tree

Member Function Documentation

has_key()

bool realization::config::Forcing::has_key ( const std::string & key ) const

inline

Test if a particualr forcing parameter exists.

Parameters

key	parameter name to test

Returns

true if the forcing properties contain key

false if the key is not in the forcing properties

References parameters.

Referenced by realization::Formulation_Manager::construct_formulation_from_config().

Member Data Documentation

parameters

geojson::PropertyMap realization::config::Forcing::parameters

key -> Property mapping for forcing parameters

Referenced by realization::Formulation_Manager::construct_formulation_from_config(), realization::Formulation_Manager::construct_missing_formulation(), and has_key().

---

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

• include/realizations/config/forcing.hpp