VIPRA::CoordModules::OutputCoordinator Class Reference

Inheritance diagram for VIPRA::CoordModules::OutputCoordinator:

Collaboration diagram for VIPRA::CoordModules::OutputCoordinator:

Public Member Functions
	VIPRA_MODULE_NAME ("coordinator")
	VIPRA_MODULE_TYPE (Output)
void	reset_modules ()
void	add_output (std::unique_ptr< Modules::Output > &&module, std::function< void(void *, Parameters &, VIPRA::Random::Engine &)> &&config)
void	config (Parameters &paramIn, VIPRA::Random::Engine &engine)
void	new_run (VIPRA::idx runIdx)
	Creates a new output directory for the current simulation run.
void	write ()
	Calls write on all outputs, returning a tuple of the results or VOID.
void	timestep_update (VIPRA::timestep timestep, VIPRA::delta_t timestepSize, VIPRA::State const &state)
void	write_to_file (std::string const &filename, std::string const &value)
	Writes a string to a file in the current output directory.
Public Member Functions inherited from VIPRA::Modules::Module< OutputCoordinator >
void	register_params (Parameters &paramIn)
	Registers the modules parameters with the parameter reader.
void	config (Parameters &paramIn, VIPRA::Random::Engine &engine)
	Loads in all parameters for the module.

Member Function Documentation

new_run()

void VIPRA::CoordModules::OutputCoordinator::new_run ( VIPRA::idx runIdx )

inline

Creates a new output directory for the current simulation run.

Parameters

runIdx

write()

void VIPRA::CoordModules::OutputCoordinator::write ( )

inline

Calls write on all outputs, returning a tuple of the results or VOID.

Returns

Util::result_or_VOID_tuple<std::tuple<output_ts...>>::type

write_to_file()

void VIPRA::CoordModules::OutputCoordinator::write_to_file ( std::string const & filename, std::string const & value )

inline

Writes a string to a file in the current output directory.

Parameters

filename
value

---

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

• include/vipra/special_modules/output.hpp