realization::Formulation Class Reference

#include <Formulation.hpp>

Inheritance diagram for realization::Formulation:

Collaboration diagram for realization::Formulation:

Public Types
typedef long	time_step_t

Public Member Functions
	Formulation (std::string id)
virtual	~Formulation ()
virtual std::string	get_formulation_type () const =0
std::string	get_id () const
virtual void	create_formulation (boost::property_tree::ptree &config, geojson::PropertyMap *global=nullptr)=0
virtual void	create_formulation (geojson::PropertyMap properties)=0

Protected Member Functions
virtual const std::vector< std::string > &	get_required_parameters () const =0
geojson::PropertyMap	interpret_parameters (boost::property_tree::ptree &config, geojson::PropertyMap *global=nullptr)
void	validate_parameters (geojson::PropertyMap options)

Protected Attributes
std::string	id

Member Typedef Documentation

time_step_t

long realization::Formulation::time_step_t

Constructor & Destructor Documentation

Formulation()

realization::Formulation::Formulation ( std::string id )

inline

~Formulation()

virtual realization::Formulation::~Formulation ( )

inlinevirtual

Member Function Documentation

create_formulation() [1/2]

virtual void realization::Formulation::create_formulation ( boost::property_tree::ptree & config, geojson::PropertyMap * global = nullptr )

pure virtual

Implemented in realization::Bmi_Module_Formulation, realization::Bmi_Multi_Formulation, and realization::Catchment_Formulation.

create_formulation() [2/2]

virtual void realization::Formulation::create_formulation ( geojson::PropertyMap properties )

pure virtual

Implemented in realization::Bmi_Module_Formulation, realization::Bmi_Multi_Formulation, and realization::Catchment_Formulation.

get_formulation_type()

virtual std::string realization::Formulation::get_formulation_type ( ) const

pure virtual

Implemented in realization::Bmi_C_Formulation, realization::Bmi_Cpp_Formulation, and realization::Bmi_Multi_Formulation.

Referenced by realization::Bmi_Module_Formulation::get_response(), realization::Bmi_Module_Formulation::get_value(), realization::Bmi_Module_Formulation::get_values(), and validate_parameters().

get_id()

std::string realization::Formulation::get_id ( ) const

inline

References id.

get_required_parameters()

virtual const std::vector< std::string > & realization::Formulation::get_required_parameters ( ) const

protectedpure virtual

Implemented in realization::Bmi_Formulation, realization::Bmi_Module_Formulation, and realization::Catchment_Formulation.

Referenced by validate_parameters().

interpret_parameters()

geojson::PropertyMap realization::Formulation::interpret_parameters ( boost::property_tree::ptree & config, geojson::PropertyMap * global = nullptr )

inlineprotected

References validate_parameters().

Referenced by realization::Bmi_Module_Formulation::create_formulation(), and realization::Bmi_Multi_Formulation::create_formulation().

validate_parameters()

void realization::Formulation::validate_parameters ( geojson::PropertyMap options )

inlineprotected

References get_formulation_type(), and get_required_parameters().

Referenced by realization::Bmi_Multi_Formulation::create_multi_formulation(), realization::Bmi_Module_Formulation::inner_create_formulation(), and interpret_parameters().

Member Data Documentation

id

std::string realization::Formulation::id

protected

Referenced by get_id().

---

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

• include/realizations/catchment/Formulation.hpp