realization Namespace Reference

Namespaces
namespace	config

Classes
class	Bmi_C_Formulation
class	Bmi_Cpp_Formulation
	Encapsulates a bmi::Bmi model in C++ such that it can be loaded as a formulation, as such also so that it can be dynamically loaded from a shared library file. More...
class	Bmi_Formulation
	Abstraction of formulation with backing model object(s) that implements the BMI. More...
class	Bmi_Module_Formulation
	Abstraction of a formulation with a single backing model object that implements the BMI. More...
class	Bmi_Multi_Formulation
	Abstraction of a formulation with multiple backing model object that implements the BMI. More...
class	Bmi_Var_Details
	Type to hold some certain details about a BMI module variable that the framework will need to use repeatedly. More...
class	ConfigurationException
	Custom exception indicating a problem when integrating with the provided realization configuration. More...
class	Formulation
	A model attached to a feature: what is run for that feature, and what it emits. More...
class	Formulation_Manager

Typedefs
using	constructor = std::shared_ptr<Formulation> (*)(std::string, std::shared_ptr<data_access::GenericDataProvider>)

Functions
static std::string	valid_formulation_keys ()
static bool	formulation_exists (std::string formulation_type)
std::shared_ptr< Formulation >	construct_formulation (std::string formulation_type, std::string identifier, forcing_params &forcing_config)
static bool	is_var_name_in_collection (const std::vector< std::string > &all_names, const std::string &var_name)
template<class T >
static constructor	create_formulation_constructor ()
static std::string	get_formulation_key (const boost::property_tree::ptree &tree)

Variables
std::map< std::string, constructor >	formulation_constructors

Typedef Documentation

constructor

using realization::constructor = std::shared_ptr<Formulation> (*)(std::string, std::shared_ptr<data_access::GenericDataProvider>)

Function Documentation

construct_formulation()

std::shared_ptr< Formulation > realization::construct_formulation	(	std::string	formulation_type,
		std::string	identifier,
		forcing_params &	forcing_config )

References formulation_constructors, utils::getStdOut(), forcing_params::path, forcing_params::provider, forcing_params::simulation_end_t, and forcing_params::simulation_start_t.

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

create_formulation_constructor()

template<class T >

static constructor realization::create_formulation_constructor ( )

static

formulation_exists()

static bool realization::formulation_exists ( std::string formulation_type )

static

References formulation_constructors.

Referenced by realization::Formulation_Manager::construct_formulation_from_config(), and get_formulation_key().

get_formulation_key()

static std::string realization::get_formulation_key ( const boost::property_tree::ptree & tree )

static

References formulation_exists().

is_var_name_in_collection()

static bool realization::is_var_name_in_collection ( const std::vector< std::string > & all_names, const std::string & var_name )

static

Referenced by realization::Bmi_Module_Formulation::is_bmi_input_variable(), and realization::Bmi_Module_Formulation::is_bmi_output_variable().

valid_formulation_keys()

static std::string realization::valid_formulation_keys ( )

static

References formulation_constructors.

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

Variable Documentation

formulation_constructors

std::map< std::string, constructor > realization::formulation_constructors

Initial value:

= {
        {"bmi_c++", create_formulation_constructor<Bmi_Cpp_Formulation>()},
 
 
 
 
 
 
        {"bmi_multi", create_formulation_constructor<Bmi_Multi_Formulation>()},
 
 
 
    }

Referenced by construct_formulation(), formulation_exists(), and valid_formulation_keys().