Belle II Software  release-08-01-10
BaseEventTimeExtractor< AIOTypes > Class Template Referenceabstract

Class to extract the event t0. More...

#include <BaseEventTimeExtractor.dcl.h>

Inheritance diagram for BaseEventTimeExtractor< AIOTypes >:
Collaboration diagram for BaseEventTimeExtractor< AIOTypes >:

Public Types

using IOTypes = std::tuple< AIOTypes... >
 Types that should be served to apply on invokation.
 
using IOVectors = std::tuple< std::vector< AIOTypes >... >
 Vector types that should be served to apply on invokation.
 

Public Member Functions

bool wasSuccessful () const
 Returns true if the last run t0 extraction was successful.
 
virtual void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose our parameters to the super module.
 
virtual void initialize () override
 Initialize the event t0 store obj ptr.
 
virtual void beginEvent () override
 Create the event t0 store obj ptr.
 
virtual std::string getDescription ()
 Brief description of the purpose of the concret findlet.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
void beginRun () override
 Receive and dispatch signal for the beginning of a new run.
 
void endRun () override
 Receive and dispatch signal for the end of the run.
 
void terminate () override
 Receive and dispatch Signal for termination of the event processing.
 

Protected Types

using ToVector = typename ToVectorImpl< T >::Type
 Short hand for ToRangeImpl.
 

Protected Member Functions

void resetEventT0 () const
 Reset the t0 value to cached value if it exists or clear it otherwise.
 
void addProcessingSignalListener (ProcessingSignalListener *psl)
 Register a processing signal listener to be notified.
 
int getNProcessingSignalListener ()
 Get the number of currently registered listeners.
 

Protected Attributes

StoreObjPtr< EventT0m_eventT0
 Pointer to the storage of the eventwise T0 estimation in the data store.
 
bool m_wasSuccessful = false
 Variable to show that the execution was successful.
 

Private Types

using Super = TrackFindingCDC::Findlet< AIOTypes... >
 Type of the base class.
 

Private Attributes

bool m_param_overwriteExistingEstimation = true
 Parameter if it is fine to overwrite the current EventT0.
 
std::optional< EventT0::EventT0Componentm_eventT0Before
 Storage for the event t0 before this module ran.
 
std::vector< ProcessingSignalListener * > m_subordinaryProcessingSignalListeners
 References to subordinary signal processing listener contained in this findlet.
 
bool m_initialized = false
 Flag to keep track whether initialization happend before.
 
bool m_terminated = false
 Flag to keep track whether termination happend before.
 
std::string m_initializedAs
 Name of the type during initialisation.
 

Detailed Description

template<class ... AIOTypes>
class Belle2::BaseEventTimeExtractor< AIOTypes >

Class to extract the event t0.

Definition at line 22 of file BaseEventTimeExtractor.dcl.h.


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