realization::config::Config Struct Reference

Structure representing the configuration for a general Formulation. More...

#include <config.hpp>

Collaboration diagram for realization::config::Config:

Public Member Functions
	Config ()=default
	Construct a new Config object.
	Config (const boost::property_tree::ptree &tree)
	Construct a new Config object from a property tree.
bool	has_formulation ()
	Determine if the config has a formulation.

Public Attributes
Formulation	formulation
Forcing	forcing

Detailed Description

Structure representing the configuration for a general Formulation.

Constructor & Destructor Documentation

Config() [1/2]

realization::config::Config::Config ( )

default

Construct a new Config object.

Config() [2/2]

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

inline

Construct a new Config object from a property tree.

Parameters

tree

References forcing, and formulation.

Member Function Documentation

has_formulation()

bool realization::config::Config::has_formulation ( )

inline

Determine if the config has a formulation.

Returns

true if the formulation name/type is set or if model parameters are present

false if either the type or parameters are empty

References formulation, realization::config::Formulation::parameters, and realization::config::Formulation::type.

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

Member Data Documentation

forcing

Forcing realization::config::Config::forcing

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

formulation

Formulation realization::config::Config::formulation

Referenced by Config(), realization::Formulation_Manager::construct_formulation_from_config(), realization::Formulation_Manager::construct_missing_formulation(), has_formulation(), and realization::Formulation_Manager::read().

---

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

• include/realizations/config/config.hpp