LDMX Software
EventProcessor.h File Reference

Base classes for all user event processing components to extend. More...

#include "Framework/Conditions.h"
#include "Framework/Configure/Parameters.h"
#include "Framework/Event.h"
#include "Framework/Exception/Exception.h"
#include "Framework/Factory.h"
#include "Framework/HistogramPool.h"
#include "Framework/Logger.h"
#include "Framework/NtupleManager.h"
#include "Framework/RunHeader.h"
#include "Framework/StorageControl.h"
#include <any>
#include <map>

Go to the source code of this file.

Classes

class  framework::AbortEventException
 Specific exception used to abort an event. More...
 
class  framework::EventProcessor
 Base class for all event processing components. More...
 
class  framework::Producer
 Base class for a module which produces a data product. More...
 
class  framework::Analyzer
 Base class for a module which does not produce a data product. More...
 

Namespaces

namespace  framework
 All classes in the ldmx-sw project use this namespace.
 

Macros

#define DECLARE_PRODUCER(CLASS)
 Macro which allows the framework to construct a producer given its name during configuration.
 
#define DECLARE_ANALYZER(CLASS)
 Macro which allows the framework to construct an analyzer given its name during configuration.
 

Detailed Description

Base classes for all user event processing components to extend.

Author
Jeremy Mans, University of Minnesota

Definition in file EventProcessor.h.

Macro Definition Documentation

◆ DECLARE_ANALYZER

#define DECLARE_ANALYZER ( CLASS)
Value:
#define FACTORY_REGISTRATION(prototype, derived)
Register a new class with a specific factory.
Definition Factory.h:469
Base class for all event processing components.

Macro which allows the framework to construct an analyzer given its name during configuration.

Parameters
CLASSThe fully-specified name of the class to register (including any namespaces)
Attention
Every Analyzer class must call this macro in the associated implementation (.cxx) file.

We just call FACTORY_REGISTRATION with framework::EventProcessor as the first argument, so look there for the implementation details.

Definition at line 363 of file EventProcessor.h.

363#define DECLARE_ANALYZER(CLASS) \
364 FACTORY_REGISTRATION(framework::EventProcessor, CLASS)

◆ DECLARE_PRODUCER

#define DECLARE_PRODUCER ( CLASS)
Value:

Macro which allows the framework to construct a producer given its name during configuration.

Parameters
CLASSThe fully-specified name of the class to register (including any namespaces)
Attention
Every Producer class must call this macro in the associated implementation (.cxx) file.

We just call FACTORY_REGISTRATION with framework::EventProcessor as the first argument, so look there for the implementation details.

Definition at line 348 of file EventProcessor.h.

348#define DECLARE_PRODUCER(CLASS) \
349 FACTORY_REGISTRATION(framework::EventProcessor, CLASS)