Mēnsūra
Public Member Functions | Protected Attributes | List of all members
GenParticleReader Class Reference

Abstract base class for a reader plugin that provides collection of generator particles. More...

#include <GenParticleReader.hpp>

Inheritance diagram for GenParticleReader:
ReaderPlugin Plugin PECGenParticleReader

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.
 
GenParticleReaderoperator= (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.
 
- Public Member Functions inherited from ReaderPlugin
 ReaderPlugin (std::string const &name)
 Constructor.
 
 ReaderPlugin (ReaderPlugin const &)=default
 Default copy constructor.
 
 ReaderPlugin (ReaderPlugin &&)=default
 Default move constructor.
 
ReaderPluginoperator= (ReaderPlugin const &)=default
 Default assignment operator.
 
virtual ~ReaderPlugin ()
 Trivial destructor.
 
- Public Member Functions inherited from Plugin
 Plugin (std::string const &name)
 Constructor.
 
 Plugin (Plugin const &)=default
 Default copy constructor.
 
 Plugin (Plugin &&)=default
 Default move constructor.
 
Pluginoperator= (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 PluginClone () 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< GenParticleparticles
 Collection of selected generator particles in the current event.
 

Additional Inherited Members

- Public Types inherited from Plugin
enum  EventOutcome { EventOutcome::Ok, EventOutcome::FilterFailed, EventOutcome::NoEvents }
 Outcome of processing of an event. More...
 
- Protected Member Functions inherited from Plugin
Plugin const * GetDependencyPlugin (std::string const &name) const
 Returns a pointer to a precedent plugin in the path with the given name. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

GenParticleReader::GenParticleReader ( std::string const  name = "GenParticles")

Creates a plugin with the given name.

User is encouraged to keep the default name.


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