Belle II Software  release-08-01-10
StoreVectorSwapper< IOType, a_alwaysWrite > Class Template Referenceabstract

Refines the clustering of wire hits from clusters to clusters. More...

#include <StoreVectorSwapper.h>

Inheritance diagram for StoreVectorSwapper< IOType, a_alwaysWrite >:
Collaboration diagram for StoreVectorSwapper< IOType, a_alwaysWrite >:

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

 StoreVectorSwapper (const std::string &storeVectorName, const std::string &classMnemomicName="", const std::string &classMnemomicDescription="")
 Constructor taking the default name of the store vector which is the target of the swap.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the parameters to a module.
 
std::string getDescription () override
 Short description of the findlet.
 
void initialize () override
 Receive signal before the start of the event processing.
 
void beginEvent () override
 Receive signal for the start of a new event. More...
 
void apply (std::vector< IOType > &input) final
 Swaps the items to the DataStore or to the backup storage location.
 
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 addProcessingSignalListener (ProcessingSignalListener *psl)
 Register a processing signal listener to be notified.
 
int getNProcessingSignalListener ()
 Get the number of currently registered listeners.
 

Private Types

using Super = Findlet< IOType >
 Type of the base class.
 

Private Attributes

std::string m_param_storeVectorName
 Name of the store vector to be used.
 
bool m_param_writeStoreVector = a_alwaysWrite
 Switch if the store vector should be filled.
 
std::string m_classMnemomicName
 Short name for the type of objects to be written out.
 
std::string m_classMnemomicDescription
 Short description for the type of objects to be written out.
 
std::vector< IOType > m_backup
 Backup storage if the vector should not be written to the DataStore.
 
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 IOType, bool a_alwaysWrite = false>
class Belle2::TrackFindingCDC::StoreVectorSwapper< IOType, a_alwaysWrite >

Refines the clustering of wire hits from clusters to clusters.

Helper findlet to allow combined findlets to export more data to the DataStore. This is mainly to temporarily maintain the former behaviour of some finder parts that used to expose more of their internals.

Definition at line 30 of file StoreVectorSwapper.h.

Member Function Documentation

◆ beginEvent()

void beginEvent ( )
inlineoverridevirtual

Receive signal for the start of a new event.

Attain super cluster vector on the DataStore if needed.

Reimplemented from ProcessingSignalListener.

Definition at line 101 of file StoreVectorSwapper.h.

102  {
104 
107  StoreWrappedObjPtr< std::vector<IOType> > storeVector(m_param_storeVectorName);
108  if (not storeVector.isValid()) {
109  storeVector.construct();
110  }
111  }
112  m_backup.clear();
113  }
void beginEvent() override
Receive and dispatch signal for the start of a new event.
std::vector< IOType > m_backup
Backup storage if the vector should not be written to the DataStore.
bool m_param_writeStoreVector
Switch if the store vector should be filled.
std::string m_param_storeVectorName
Name of the store vector to be used.

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