VariadicUnionVarSet< AVarSets > Class Template Reference

Class that accommodates many variable sets and presents them as on set of variables. More...

#include <VariadicUnionVarSet.h>

Inheritance diagram for VariadicUnionVarSet< AVarSets >:

Public Types
using	Object = typename Super::Object
	Object type from which variables shall be extracted.

Public Member Functions
	VariadicUnionVarSet ()
	Create the union variable set.
void	initialize () final
	Initialize all contained variable set before event processing.
bool	extract (const Object *obj) final
	Main method that extracts the variable values from the complex object.
std::vector< Named< Float_t * > >	getNamedVariables (const std::string &prefix) override
	Getter for the named references to the individual variables Base implementation returns empty vector.
MayBePtr< Float_t >	find (const std::string &varName) override
	Pointer to the variable with the given name.
virtual bool	extract (const Object *obj)
	Main method that extracts the variable values from the complex object.
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 implementation returns empty vector.
std::vector< Named< Float_t * > >	getNamedVariables ()
	Getter for the named references to the individual variables.
virtual bool	extract (const Object *obj)
	Main method that extracts the variable values from the complex object.
bool	extract (const Object &obj)
	Method for extraction from an object instead of a pointer.
std::map< std::string, Float_t >	getNamedValues (const std::string &prefix) const
	Getter for a map of names to float values.
std::map< std::string, Float_t >	getNamedValues () const
	Getter for a map of names to float values.
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 = BaseVarSet< typename FirstType< AVarSets... >::Object >
	Type of the super class.
using	ContainedVarSet = BaseVarSet< Object >
	Type of the contained variable sets.

Private Attributes
UnionVarSet< Object >	m_multiVarSet
	Container for the multiple variable sets.
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 happened before.
bool	m_terminated = false
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class... AVarSets>
class Belle2::TrackFindingCDC::VariadicUnionVarSet< AVarSets >

Class that accommodates many variable sets and presents them as on set of variables.

In contrast to the UnionVarSet the individual VarSets are given as variadic template parameters.

Dummy implementation based on UnionVarSet. The UnionVarSet can be optimized and leverage that the types of all nested variable sets are known at compile time.

Definition at line 37 of file VariadicUnionVarSet.h.

Member Typedef Documentation

ContainedVarSet

using ContainedVarSet = BaseVarSet<Object>

private

Type of the contained variable sets.

Definition at line 49 of file VariadicUnionVarSet.h.

Object

using Object = typename Super::Object

Object type from which variables shall be extracted.

Definition at line 45 of file VariadicUnionVarSet.h.

Super

using Super = BaseVarSet<typename FirstType<AVarSets...>::Object>

private

Type of the super class.

Definition at line 41 of file VariadicUnionVarSet.h.

Constructor & Destructor Documentation

VariadicUnionVarSet()

VariadicUnionVarSet ( )

inlineexplicit

Create the union variable set.

Definition at line 53 of file VariadicUnionVarSet.h.

      {
        EvalVariadic{(m_multiVarSet.push_back(std::make_unique<AVarSets>()), std::ignore)...};
        assert(m_multiVarSet.size() == sizeof...(AVarSets));
      }

Member Function Documentation

addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener *  psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

beginEvent()

void beginEvent ( )

overridevirtualinherited

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

extract() [1/5]

bool extract ( const Object &  obj )

inlineinherited

Method for extraction from an object instead of a pointer.

Definition at line 56 of file BaseVarSet.h.

      {
        return extract(&obj);
      }

extract() [2/5]

bool extract ( const Object &  obj )

inline

Method for extraction from an object instead of a pointer.

Definition at line 56 of file BaseVarSet.h.

      {
        return extract(&obj);
      }

extract() [3/5]

virtual bool extract ( const Object *  obj )

inlinevirtualinherited

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

obj	dummy object not used

Returns

: always true for the base implementation

Definition at line 50 of file BaseVarSet.h.

      {
        return true;
      }

extract() [4/5]

virtual bool extract ( const Object *  obj )

inline

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

obj	dummy object not used

Returns

: always true for the base implementation

Definition at line 50 of file BaseVarSet.h.

      {
        return true;
      }

extract() [5/5]

bool extract ( const Object *  obj )

inlinefinal

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

Returns

Indication whether the extraction could be completed successfully.

Definition at line 73 of file VariadicUnionVarSet.h.

      {
        return m_multiVarSet.extract(obj);
      }

find()

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

inlineoverridevirtual

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented from BaseVarSet< FirstType< AVarSets... >::Object >.

Definition at line 94 of file VariadicUnionVarSet.h.

      {
        return m_multiVarSet.find(varName);
      }

getNamedValues() [1/2]

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

inlineinherited

Getter for a map of names to float values.

Definition at line 95 of file BaseVarSet.h.

      {
        const std::string prefix = "";
        return this->getNamedValues(prefix);
      }

getNamedValues() [2/2]

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

inlineinherited

Getter for a map of names to float values.

Parameters

prefix

Name prefix to apply to all variable names.

Definition at line 83 of file BaseVarSet.h.

      {
        std::map<std::string, Float_t> result;
        std::vector<Named<Float_t*> > namedVariables = this->getNamedVariables(prefix);
        for (const Named<Float_t*>& namedVariable : namedVariables) {
          Float_t* variable = namedVariable;
          result[namedVariable.getName()] = *variable;
        }
        return result;
      }

getNamedVariables() [1/3]

std::vector< Named< Float_t * > > getNamedVariables ( )

inline

Getter for the named references to the individual variables.

Definition at line 73 of file BaseVarSet.h.

      {
        const std::string prefix = "";
        return this->getNamedVariables(prefix);
      }

getNamedVariables() [2/3]

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

inlinevirtual

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

Parameters

prefix

Name prefix to apply to all variable names.

Returns

: in base implementation always an empty vector

Reimplemented from BaseVarSet< FirstType< AVarSets... >::Object >.

Definition at line 67 of file BaseVarSet.h.

      {
        return {};
      }

getNamedVariables() [3/3]

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

inlineoverridevirtual

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

Reimplemented from BaseVarSet< FirstType< AVarSets... >::Object >.

Definition at line 85 of file VariadicUnionVarSet.h.

      {
        return m_multiVarSet.getNamedVariables(prefix);
      }

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

inlinefinalvirtual

Initialize all contained variable set before event processing.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 63 of file VariadicUnionVarSet.h.

      {
        this->addProcessingSignalListener(&m_multiVarSet);
        Super::initialize();
      }

terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_multiVarSet

UnionVarSet<Object> m_multiVarSet

private

Container for the multiple variable sets.

Definition at line 101 of file VariadicUnionVarSet.h.

m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/trackFindingCDC/varsets/include/VariadicUnionVarSet.h