CORSIKA  @c8_version@
The framework to simulate particle cascades for astroparticle physics
corsika::WriterOff Class Reference

Generic class to switch off any output. More...

#include <WriterOff.hpp>

Inheritance diagram for corsika::WriterOff:

Public Member Functions

template<typename... TArgs>
 WriterOff (TArgs &&...)
 The purpose of this catch-all constructor is to discard all parameters. More...
 
void startOfLibrary (boost::filesystem::path const &) override
 Called at the start of each run.
 
void endOfShower (unsigned int const) override
 Called at the end of each event/shower. More...
 
void endOfLibrary () override
 Called at the end of each run.
 
template<typename... TArgs>
void write (TArgs &&...)
 The purpose of this catch-all method is to discard all data. More...
 
virtual YAML::Node getConfig () const
 Provide YAML configuration for this BaseOutput.
 
- Public Member Functions inherited from corsika::BaseOutput
virtual void startOfShower (unsigned int const)
 Called at the start of each event/shower. More...
 
bool isInit () const
 Flag to indicate readiness.
 
virtual YAML::Node getSummary () const
 Provide YAML Summary for this BaseOutput.
 

Additional Inherited Members

- Protected Member Functions inherited from corsika::BaseOutput
void setInit (bool const v)
 Set init flag.
 

Detailed Description

Generic class to switch off any output.

The 'write' method is catch-all and does nothing.

Definition at line 21 of file WriterOff.hpp.

Constructor & Destructor Documentation

◆ WriterOff()

template<typename... TArgs>
corsika::WriterOff::WriterOff ( TArgs &&  ...)
inline

The purpose of this catch-all constructor is to discard all parameters.

Template Parameters
TArgs

Definition at line 29 of file WriterOff.hpp.

Member Function Documentation

◆ endOfShower()

void corsika::WriterOff::endOfShower ( unsigned int  showerId)
inlineoverridevirtual

Called at the end of each event/shower.

Parameters
showerIdShower counter.

Implements corsika::BaseOutput.

Definition at line 35 of file WriterOff.hpp.

◆ write()

template<typename... TArgs>
void corsika::WriterOff::write ( TArgs &&  ...)
inline

The purpose of this catch-all method is to discard all data.

Template Parameters
TArgs

Definition at line 44 of file WriterOff.hpp.


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