PECGenParticleReader Class Reference

Constructs collection of generator-level particles. More...

#include <PECGenParticleReader.hpp>

Inheritance diagram for PECGenParticleReader:

Public Member Functions
	PECGenParticleReader (std::string const name="GenParticles")
	Creates plugin with the given name. More...
	PECGenParticleReader (PECGenParticleReader const &src) noexcept
	Copy constructor.
	PECGenParticleReader (PECGenParticleReader &&)=default
	Default move constructor.
PECGenParticleReader &	operator= (PECGenParticleReader const &)=delete
	Assignment operator is deleted.
virtual	~PECGenParticleReader () noexcept
	Trivial destructor.
virtual void	BeginRun (Dataset const &) override
	Sets up reading of trees with electrons and muons. More...
virtual Plugin *	Clone () const override
	Creates a newly configured clone. More...
Public Member Functions inherited from GenParticleReader
	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.
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.
ReaderPlugin &	operator= (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.
Plugin &	operator= (Plugin const &)=default
	Default assignment operator.
virtual	~Plugin ()
	Trivial destructor.
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...

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...
Protected Attributes inherited from GenParticleReader
std::vector< GenParticle >	particles
	Collection of selected generator particles in the current event.

Detailed Description

Constructs collection of generator-level particles.

This plugin reads collection generator-level particles from a PEC file (with the help of a PECInputData plugin) and reconstructs mother-daughter relations.

Constructor & Destructor Documentation

PECGenParticleReader::PECGenParticleReader

(

std::string const

name = "GenParticles"

)

Creates plugin with the given name.

User is encouraged to keep the default name.

Member Function Documentation

void PECGenParticleReader::BeginRun ( Dataset const &  )

overridevirtual

Sets up reading of trees with electrons and muons.

Reimplemented from Plugin.

Reimplemented from Plugin.

Plugin * PECGenParticleReader::Clone ( ) const

overridevirtual

Creates a newly configured clone.

Implemented from Plugin.

Implements Plugin.

---

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

• include/mensura/PECReader/PECGenParticleReader.hpp
• modules/PECReader/src/PECGenParticleReader.cpp