Mēnsūra
|
Abstract base class for a reader plugin that provides collection of generator particles. More...
#include <GenParticleReader.hpp>
Public Member Functions | |
GenParticleReader (std::string const name="GenParticles") | |
Creates a plugin with the given name. More... | |
GenParticleReader (GenParticleReader const &)=default | |
Default copy constructor. | |
GenParticleReader (GenParticleReader &&)=default | |
Default move constructor. | |
GenParticleReader & | operator= (GenParticleReader const &)=delete |
Assignment operator is deleted. | |
virtual | ~GenParticleReader () |
Trivial destructor. | |
virtual std::vector< GenParticle > const & | GetParticles () const |
Returns collection of selected generator particles in the current event. | |
![]() | |
ReaderPlugin (std::string const &name) | |
Constructor. | |
ReaderPlugin (ReaderPlugin const &)=default | |
Default copy constructor. | |
ReaderPlugin (ReaderPlugin &&)=default | |
Default move constructor. | |
ReaderPlugin & | operator= (ReaderPlugin const &)=default |
Default assignment operator. | |
virtual | ~ReaderPlugin () |
Trivial destructor. | |
![]() | |
Plugin (std::string const &name) | |
Constructor. | |
Plugin (Plugin const &)=default | |
Default copy constructor. | |
Plugin (Plugin &&)=default | |
Default move constructor. | |
Plugin & | operator= (Plugin const &)=default |
Default assignment operator. | |
virtual | ~Plugin () |
Trivial destructor. | |
virtual void | BeginRun (Dataset const &dataset) |
Performs initialization needed when processing of a new dataset starts. More... | |
virtual Plugin * | Clone () const =0 |
Clones the object. More... | |
virtual void | EndRun () |
Performs necessary actions needed after processing of a dataset is finished. More... | |
Processor const & | GetMaster () const |
Returns a reference to the master. More... | |
std::string const & | GetName () const |
Returns name of the plugin. | |
EventOutcome | ProcessEventToOutcome () |
Processes a new event from the current dataset. More... | |
void | SetMaster (Processor const *processor) |
Provides a pointer to an instance of Processor class that owns the plugin. More... | |
Protected Attributes | |
std::vector< GenParticle > | particles |
Collection of selected generator particles in the current event. | |
Additional Inherited Members | |
![]() | |
enum | EventOutcome { EventOutcome::Ok, EventOutcome::FilterFailed, EventOutcome::NoEvents } |
Outcome of processing of an event. More... | |
![]() | |
Plugin const * | GetDependencyPlugin (std::string const &name) const |
Returns a pointer to a precedent plugin in the path with the given name. More... | |
Abstract base class for a reader plugin that provides collection of generator particles.
Typically, only a small subset of all generator-level particles is stored in the input files. This plugin provides an access to this small collection.
GenParticleReader::GenParticleReader | ( | std::string const | name = "GenParticles" | ) |
Creates a plugin with the given name.
User is encouraged to keep the default name.