realization::config::Time Struct Reference

Simple structure for holding time bounds and output interval (seconds) More...

#include <time.hpp>

Collaboration diagram for realization::config::Time:

Public Member Functions
	Time (const boost::property_tree::ptree &tree)
	Construct a new Time object from a boost property tree.
simulation_time_params	make_params ()
	Converts string based parameters start_time and end_time into time structs for use as simulation_time_params.

Public Attributes
std::string	start_time
std::string	end_time
unsigned int	output_interval

Detailed Description

Simple structure for holding time bounds and output interval (seconds)

Constructor & Destructor Documentation

Time()

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

inline

Construct a new Time object from a boost property tree.

The tree should have the following keys, and if not the given defaults are applied start_time (default "") end_time (default "") output_interval (default 0)

Parameters

tree	boost property tree to construct Time from

References end_time, output_interval, and start_time.

Member Function Documentation

make_params()

simulation_time_params realization::config::Time::make_params ( )

inline

Converts string based parameters start_time and end_time into time structs for use as simulation_time_params.

Returns

simulation_time_params

References end_time, output_interval, and start_time.

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

Member Data Documentation

end_time

std::string realization::config::Time::end_time

Referenced by Time(), and make_params().

output_interval

unsigned int realization::config::Time::output_interval

Referenced by Time(), and make_params().

start_time

std::string realization::config::Time::start_time

Referenced by Time(), and make_params().

---

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

• include/realizations/config/time.hpp