CORSIKA8  0.0.0
The framework to simulate particle cascades for astroparticle physics
corsika::OutputManager Class Referencefinal

#include <OutputManager.hpp>

Public Member Functions

 OutputManager (std::string const &name, 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)
 Register an existing output to this manager. More...
 
void startOfLibrary ()
 Called at the start of each library. More...
 
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...
 

Detailed Description

Manages CORSIKA 8 output streams.

Definition at line 21 of file OutputManager.hpp.

Constructor & Destructor Documentation

◆ OutputManager()

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

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

Parameters
nameThe name of this output collection.
dirThe directory where the output directory will be stored.

Member Function Documentation

◆ add()

template<typename TOutput >
void corsika::OutputManager::add ( std::string const &  name,
TOutput &  output 
)

Register an existing output to this manager.

Parameters
nameThe unique name of this output.
args...These are perfect forwarded to the constructor of the output.

◆ 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.

◆ startOfLibrary()

void corsika::OutputManager::startOfLibrary ( )

Called at the start of each library.

This iteratively calls startOfLibrary on each registered output.

◆ 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: