Belle II Software  release-08-01-10
BaseVarSet< AObject > Class Template Reference

Generic class that generates some named float values from a given object. More...

#include <BaseVarSet.h>

Inheritance diagram for BaseVarSet< AObject >:
Collaboration diagram for BaseVarSet< AObject >:

Public Types

using Object = AObject
 Object type from which variables shall be extracted.
 

Public Member Functions

virtual ~BaseVarSet ()=default
 Making destructor virtual.
 
virtual bool extract (const Object *obj)
 Main method that extracts the variable values from the complex object. More...
 
bool extract (const Object &obj)
 Method for extraction from an object instead of a pointer.
 
virtual std::vector< Named< Float_t * > > getNamedVariables (const std::string &prefix)
 Getter for the named references to the individual variables Base implementaton returns empty vector. More...
 
std::vector< Named< Float_t * > > getNamedVariables ()
 Getter for the named references to the individual variables.
 
std::map< std::string, Float_t > getNamedValues (const std::string &prefix) const
 Getter for a map of names to float values. More...
 
std::map< std::string, Float_t > getNamedValues () const
 Getter for a map of names to float values.
 
virtual MayBePtr< Float_t > find (const std::string &varName)
 Pointer to the variable with the given name. More...
 
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 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 = 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 AObject>
class Belle2::TrackFindingCDC::BaseVarSet< AObject >

Generic class that generates some named float values from a given object.

Base class defining the interface for various different implementation of sets of variables.

Definition at line 33 of file BaseVarSet.h.

Member Function Documentation

◆ extract()

virtual bool extract ( const Object obj)
inlinevirtual

Main method that extracts the variable values from the complex object.

Returns indication whether the extraction could be completed successfully. Base implementation returns always true.

Parameters
objdummy object not used
Returns
: always true for the base implementation

Reimplemented in UnionVarSet< AObject >, and UnionVarSet< Object >.

Definition at line 50 of file BaseVarSet.h.

◆ find()

virtual MayBePtr<Float_t> find ( const std::string &  varName)
inlinevirtual

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented in VarSet< AVarNames >, VarSet< SegmentTrackTruthVarNames >, VarSet< BasicSegmentPairVarNames >, VarSet< PXDStateBasicVarNames >, VarSet< HitGapSegmentRelationVarNames >, VarSet< FitlessSegmentPairVarNames >, VarSet< BasicSegmentPairRelationVarNames >, VarSet< SVDResultTruthVarNames >, VarSet< CDCStateTruthVarNames >, VarSet< TruthSegmentPairVarNames >, VarSet< HitGapSegmentPairVarNames >, VarSet< FitlessSegmentRelationVarNames >, VarSet< FitSegmentPairVarNames >, VarSet< BestMatchedTruthVarNames >, VarSet< BendFacetRelationVarNames >, VarSet< BasicTrackRelationVarNames >, VarSet< PXDResultTruthVarNames >, VarSet< TruthSegmentPairRelationVarNames >, VarSet< FitlessFacetVarNames >, VarSet< FitFacetRelationVarNames >, VarSet< BasicAxialSegmentPairVarNames >, VarSet< AdvancedSegmentVarNames >, VarSet< StereoHitVarNames >, VarSet< StereoHitTruthVarNames >, VarSet< FitSegmentRelationVarNames >, VarSet< BasicSegmentVarNames >, VarSet< BasicTrackVarSetNames >, VarSet< TruthSegmentVarNames >, VarSet< BendFacetVarNames >, VarSet< SVDStateBasicVarNames >, VarSet< FilterVarNames< AFilter > >, VarSet< CDCfromEclPathTruthVarNames >, VarSet< CDCStateBasicVarNames >, VarSet< CDCPathTruthVarNames >, VarSet< BasicFacetVarNames >, VarSet< RelationSVDResultVarNames >, VarSet< TruthTrackVarNames >, VarSet< CDCPathBasicVarNames >, VarSet< FitSegmentPairRelationVarNames >, VarSet< FitFacetVarNames >, VarSet< BkgTruthClusterVarNames >, VarSet< BasicSegmentRelationVarNames >, VarSet< FitTrackRelationVarNames >, VarSet< BasicFacetRelationVarNames >, VarSet< HitGapAxialSegmentPairVarNames >, VarSet< FitlessAxialSegmentPairVarNames >, VarSet< SVDStateTruthVarNames >, VarSet< SVDResultVarNames >, VarSet< PXDStateTruthVarNames >, VarSet< PXDResultVarNames >, VarSet< TruthAxialSegmentPairVarNames >, VarSet< TrailSegmentPairVarNames >, VarSet< SegmentTrackVarNames >, VarSet< HitGapTrackRelationVarNames >, VarSet< SVDStateVarNames >, VarSet< CDCfromEclStateTruthVarNames >, VarSet< FitAxialSegmentPairVarNames >, VarSet< BasicClusterVarNames >, VariadicUnionVarSet< AVarSets >, UnionVarSet< AObject >, UnionVarSet< Object >, RelationVarSet< ABaseVarSet >, and FilterVarSet< AFilter >.

Definition at line 105 of file BaseVarSet.h.

◆ getNamedValues()

std::map<std::string, Float_t> getNamedValues ( const std::string &  prefix) const
inline

Getter for a map of names to float values.

Parameters
prefixName prefix to apply to all variable names.

Definition at line 83 of file BaseVarSet.h.

◆ getNamedVariables()

virtual std::vector<Named<Float_t*> > getNamedVariables ( const std::string &  prefix)
inlinevirtual

Getter for the named references to the individual variables Base implementaton returns empty vector.

Parameters
prefixName prefix to apply to all variable names.
Returns
: in base implementation always an empty vector

Reimplemented in VarSet< AVarNames >, VarSet< SegmentTrackTruthVarNames >, VarSet< BasicSegmentPairVarNames >, VarSet< PXDStateBasicVarNames >, VarSet< HitGapSegmentRelationVarNames >, VarSet< FitlessSegmentPairVarNames >, VarSet< BasicSegmentPairRelationVarNames >, VarSet< SVDResultTruthVarNames >, VarSet< CDCStateTruthVarNames >, VarSet< TruthSegmentPairVarNames >, VarSet< HitGapSegmentPairVarNames >, VarSet< FitlessSegmentRelationVarNames >, VarSet< FitSegmentPairVarNames >, VarSet< BestMatchedTruthVarNames >, VarSet< BendFacetRelationVarNames >, VarSet< BasicTrackRelationVarNames >, VarSet< PXDResultTruthVarNames >, VarSet< TruthSegmentPairRelationVarNames >, VarSet< FitlessFacetVarNames >, VarSet< FitFacetRelationVarNames >, VarSet< BasicAxialSegmentPairVarNames >, VarSet< AdvancedSegmentVarNames >, VarSet< StereoHitVarNames >, VarSet< StereoHitTruthVarNames >, VarSet< FitSegmentRelationVarNames >, VarSet< BasicSegmentVarNames >, VarSet< BasicTrackVarSetNames >, VarSet< TruthSegmentVarNames >, VarSet< BendFacetVarNames >, VarSet< SVDStateBasicVarNames >, VarSet< FilterVarNames< AFilter > >, VarSet< CDCfromEclPathTruthVarNames >, VarSet< CDCStateBasicVarNames >, VarSet< CDCPathTruthVarNames >, VarSet< BasicFacetVarNames >, VarSet< RelationSVDResultVarNames >, VarSet< TruthTrackVarNames >, VarSet< CDCPathBasicVarNames >, VarSet< FitSegmentPairRelationVarNames >, VarSet< FitFacetVarNames >, VarSet< BkgTruthClusterVarNames >, VarSet< BasicSegmentRelationVarNames >, VarSet< FitTrackRelationVarNames >, VarSet< BasicFacetRelationVarNames >, VarSet< HitGapAxialSegmentPairVarNames >, VarSet< FitlessAxialSegmentPairVarNames >, VarSet< SVDStateTruthVarNames >, VarSet< SVDResultVarNames >, VarSet< PXDStateTruthVarNames >, VarSet< PXDResultVarNames >, VarSet< TruthAxialSegmentPairVarNames >, VarSet< TrailSegmentPairVarNames >, VarSet< SegmentTrackVarNames >, VarSet< HitGapTrackRelationVarNames >, VarSet< SVDStateVarNames >, VarSet< CDCfromEclStateTruthVarNames >, VarSet< FitAxialSegmentPairVarNames >, VarSet< BasicClusterVarNames >, VariadicUnionVarSet< AVarSets >, UnionVarSet< AObject >, UnionVarSet< Object >, RelationVarSet< ABaseVarSet >, FilterVarSet< AFilter >, and FitSegmentPairVarSet.

Definition at line 67 of file BaseVarSet.h.


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