Mēnsūra
Public Member Functions | List of all members
AnalysisPlugin Class Reference

Abstract base class for analysis plugins. More...

#include <AnalysisPlugin.hpp>

Inheritance diagram for AnalysisPlugin:
Plugin BasicKinematicsPlugin BTagEffHistograms EventIDFilter EventIDReminderFilter EventWeightPlugin JetFilter JetFunctorFilter LeptonFilter LumiMaskFilter MetFilter PECTriggerFilter WeightCollector

Public Member Functions

 AnalysisPlugin (std::string const &name)
 Constructor.
 
 AnalysisPlugin (AnalysisPlugin const &)=default
 Default copy constructor.
 
 AnalysisPlugin (AnalysisPlugin &&)=default
 Default move constructor.
 
AnalysisPluginoperator= (AnalysisPlugin const &)=default
 Default assignment operator.
 
virtual ~AnalysisPlugin ()
 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...
 

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 analysis plugins.

Compared to the base class Plugin, here a specific logic to interpret boolean decision issued by ProcessEvent method is implemented. The decision is treated as a filter decision. If it is false, the parent Processor does not evaluate for the current event plugins that depend on the given one.

Consult documentation for the base class. In particular, in a derived class user must implement methods Clone and ProcessEvent.


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