realization::config::Formulation Struct Reference

#include <formulation.hpp>

Collaboration diagram for realization::config::Formulation:

Public Member Functions
	Formulation ()=default
	Construct a new default Formulation object.
	Formulation (std::string type, geojson::PropertyMap params)
	Construct a new Formulation object.
	Formulation (const boost::property_tree::ptree &tree)
	Construct a new Formulation object from a boost property tree.
void	link_external (geojson::Feature feature)
	Link formulation parameters to hydrofabric data held in feature.

Public Attributes
std::string	type
geojson::PropertyMap	parameters
std::vector< Formulation >	nested

Constructor & Destructor Documentation

Formulation() [1/3]

realization::config::Formulation::Formulation ( )

default

Construct a new default Formulation object.

Default objects have an "" type and and empty property map.

Referenced by Formulation().

Formulation() [2/3]

realization::config::Formulation::Formulation ( std::string type, geojson::PropertyMap params )

inline

Construct a new Formulation object.

Parameters

type	formulation type represented
params	formulation parameter mapping

Formulation() [3/3]

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

inline

Construct a new Formulation object from a boost property tree.

The tree should have a "name" key corresponding to the formulation type as well as a "params" key to build the property map from

Parameters

tree	property tree to build Formulation from

References Formulation(), nested, parameters, and type.

Member Function Documentation

link_external()

void realization::config::Formulation::link_external ( geojson::Feature feature )

inline

Link formulation parameters to hydrofabric data held in feature.

Parameters

feature

Hydrofabric feature with properties to assign to formulation model params

References geojson::List, nested, geojson::Object, parameters, and type.

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

Member Data Documentation

nested

std::vector<Formulation> realization::config::Formulation::nested

Referenced by Formulation(), and link_external().

parameters

geojson::PropertyMap realization::config::Formulation::parameters

Referenced by Formulation(), realization::Formulation_Manager::construct_formulation_from_config(), realization::Formulation_Manager::construct_missing_formulation(), realization::config::Config::has_formulation(), and link_external().

type

std::string realization::config::Formulation::type

Referenced by Formulation(), realization::Formulation_Manager::construct_formulation_from_config(), realization::Formulation_Manager::construct_missing_formulation(), realization::config::Config::has_formulation(), and link_external().

---

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

• include/realizations/config/formulation.hpp