AdderInterface< ACollectorItem, ACollectionItem > Class Template Reference

Base class for a findlet, which uses a reduced/thinned list of weighted relations between collector and collection items to absorb the matched collection items into a collector item. More...

#include <AdderInterface.h>

Inheritance diagram for AdderInterface< ACollectorItem, ACollectionItem >:

Collaboration diagram for AdderInterface< ACollectorItem, ACollectionItem >:

Public Types
using	WeightedRelationItem = WeightedRelation< ACollectorItem, const ACollectionItem >
	Shortcut class name for a weighted relation between a collector item and a collection item.
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
void	apply (std::vector< WeightedRelationItem > &weightedRelations) override
	Main function to do the adding. Override the add function below in your derived class.
virtual std::string	getDescription ()
	Brief description of the purpose of the concret findlet.
virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Forward prefixed parameters of this findlet to the module parameter list.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
void	initialize () override
	Receive and dispatch signal before the start of the event processing.
void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.
void	beginEvent () override
	Receive and dispatch signal for the start of a new event.
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
virtual void	add (ACollectorItem &collectorItem, const ACollectionItem &collectionItem, Weight weight)
	Override this function to implement how a collection item should be matched to a collector item.
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 = ProcessingSignalListener
	Type of the base class.

Private Attributes
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 ACollectorItem, class ACollectionItem>
class Belle2::TrackFindingCDC::AdderInterface< ACollectorItem, ACollectionItem >

Base class for a findlet, which uses a reduced/thinned list of weighted relations between collector and collection items to absorb the matched collection items into a collector item.

Please do not implement any logic which collection items should be added to which collector item, but handle all this in a selector (see below).

Most likely, the full stack is used as follows:

• match two lists of elements (Collectors and Collections) resulting in a list of weighted relations among those
• select only some relations using a certain criteria (this is where the difference between Collector and Collections comes into place)
• add the found relations by absorbing the collection items into the collector items.

Please note that the CollectionItems are therefore const whereas the CollectorItems are not. All the passed WeightedRelations lists must be sorted.

Most of the provided selectors are built to match many collection items to one collector item.

Definition at line 38 of file AdderInterface.h.

---

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

• tracking/trackFindingCDC/collectors/adders/include/AdderInterface.h