corsika::OutputManager Class Reference

#include <OutputManager.hpp>

Inheritance diagram for corsika::OutputManager:

Public Member Functions
	OutputManager (std::string const &name, const long &vseed, std::string const &input_args, boost::filesystem::path const &dir)
	Construct an OutputManager instance with a name in a given directory. More...
	~OutputManager ()
	Handle graceful closure of the outputs upon destruction.
template<typename TOutput >
void	add (std::string const &name, TOutput &output)
YAML::Node	getSummary () const
	Produces the summary YAML. More...
YAML::Node	getConfig () const
	Produces the config YAML. More...
void	startOfLibrary ()
	Called at the start of each library.
void	startOfShower ()
	Called at the start of each event/shower. More...
void	endOfShower ()
	Called at the end of each event/shower. More...
void	endOfLibrary ()
	Called at the end of each library. More...
int	getEventId () const
	Return current event number.
Public Member Functions inherited from corsika::YAMLStreamer
void	writeYAML (YAML::Node const &node, boost::filesystem::path const &path) const

Detailed Description

Manages CORSIKA 8 output streams.

Definition at line 22 of file OutputManager.hpp.

Constructor & Destructor Documentation

OutputManager()

corsika::OutputManager::OutputManager	(	std::string const &	name,
		const long &	vseed,
		std::string const &	input_args,
		boost::filesystem::path const &	dir
	)

Construct an OutputManager instance with a name in a given directory.

Parameters

name	The name of this output collection.
dir	The directory where the output directory will be stored.

Member Function Documentation

endOfLibrary()

void corsika::OutputManager::endOfLibrary

(

)

Called at the end of each library.

This iteratively calls endOfLibrary on each registered output.

endOfShower()

void corsika::OutputManager::endOfShower

(

)

Called at the end of each event/shower.

This iteratively calls endOfEvent on each registered output.

getConfig()

YAML::Node corsika::OutputManager::getConfig

(

)

const

Produces the config YAML.

Returns

YAML::Node

getSummary()

YAML::Node corsika::OutputManager::getSummary

(

)

const

Produces the summary YAML.

Returns

YAML::Node

startOfShower()

void corsika::OutputManager::startOfShower

(

)

Called at the start of each event/shower.

This iteratively calls startOfEvent on each registered output.

---

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

• corsika/output/OutputManager.hpp