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

Abstract base class for a reader plugin that provides collections of leptons. More...

#include <LeptonReader.hpp>

Inheritance diagram for LeptonReader:
ReaderPlugin Plugin PECLeptonReader

Public Member Functions

 LeptonReader (std::string const name="Leptons")
 Creates plugin with the given name. More...
 
 LeptonReader (LeptonReader const &)=default
 Default copy constructor.
 
 LeptonReader (LeptonReader &&)=default
 Default move constructor.
 
LeptonReaderoperator= (LeptonReader const &)=default
 Default assignment operator.
 
virtual ~LeptonReader ()
 Trivial destructor.
 
virtual std::vector< Lepton > const & GetLeptons () const
 Returns collection of tight leptons in the current event.
 
virtual std::vector< Lepton > const & GetLooseLeptons () const
 Returns collection of loose leptons in the current event. More...
 
- 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< Leptonleptons
 Collection of tight leptons in the current event.
 
std::vector< LeptonlooseLeptons
 Collection of looose leptons 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 collections of leptons.

Two collections are provided: tight and loose leptons. The latter one is expected to be used to implement veto in lepton counting. The collection of loose leptons includes tight leptons. Leptons of same flavour typically have the same selection on transverse momentum in both tight and loose categories.

Constructor & Destructor Documentation

LeptonReader::LeptonReader ( std::string const  name = "Leptons")

Creates plugin with the given name.

User is encouraged to keep the default name.

Member Function Documentation

std::vector< Lepton > const & LeptonReader::GetLooseLeptons ( ) const
virtual

Returns collection of loose leptons in the current event.

This collection includes also all tight leptons.


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