Belle II Software  release-05-02-19
EventLimiterModule.h
1 /**************************************************************************
2  * BASF2 (Belle Analysis Framework 2) *
3  * Copyright(C) 2016 - Belle II Collaboration *
4  * *
5  * Author: The Belle II Collaboration *
6  * Contributors: David Dossett *
7  * *
8  * This software is provided "as is" without any warranty. *
9  **************************************************************************/
10 #pragma once
11 
12 #include <framework/core/Module.h>
13 #include <framework/datastore/StoreObjPtr.h>
14 #include <framework/dataobjects/EventMetaData.h>
15 
16 namespace Belle2 {
30  class EventLimiterModule : public Module {
31 
32  public:
35 
37  virtual ~EventLimiterModule() {};
38 
40  virtual void initialize() override;
41 
43  virtual void event() override;
44 
46  virtual void beginRun() override;
47 
48  private:
51 
54 
57  bool m_returnValue = true;
58 
61  int m_runEvents = 0;
62  };
64 }
Belle2::EventLimiterModule::m_runEvents
int m_runEvents
How many events processed for the current run so far, stops counting up once max is hit Only used/inc...
Definition: EventLimiterModule.h:69
Belle2::EventLimiterModule::~EventLimiterModule
virtual ~EventLimiterModule()
Destructor of the module.
Definition: EventLimiterModule.h:45
Belle2::EventLimiterModule::event
virtual void event() override
Checks if we've reached the maximum number of events yet and sets the return value to False if we hav...
Definition: EventLimiterModule.cc:45
Belle2::EventLimiterModule::m_returnValue
bool m_returnValue
Flag that will be returned by the module.
Definition: EventLimiterModule.h:65
Belle2::EventLimiterModule::EventLimiterModule
EventLimiterModule()
Constructor: Sets the description, the properties and the parameters of the module.
Definition: EventLimiterModule.cc:24
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::StoreObjPtr
Type-safe access to single objects in the data store.
Definition: ParticleList.h:33
Belle2::EventLimiterModule::m_maxEventsPerRun
int m_maxEventsPerRun
Maximum number of events to be collected at the start of each run (-1 = no maximum)
Definition: EventLimiterModule.h:61
Belle2::EventLimiterModule::m_eventMetaData
StoreObjPtr< EventMetaData > m_eventMetaData
Datastore pointers.
Definition: EventLimiterModule.h:58
Belle2::EventLimiterModule::beginRun
virtual void beginRun() override
Resets our event counter to zero and return value to True.
Definition: EventLimiterModule.cc:65
Belle2::EventLimiterModule::initialize
virtual void initialize() override
Initialization states required data objects (EventMetaData)
Definition: EventLimiterModule.cc:40