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

#include <UnionVarSet.h>

Inheritance diagram for UnionVarSet< AObject >:

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

using	ContainedVarSet = BaseVarSet< Object >
	Type of the contained variable sets.

Public Member Functions
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.

void	push_back (std::unique_ptr< ContainedVarSet > varSet)
	Add a variable set to the contained variable sets.

void	clear ()
	Remove all contained variable sets.

size_t	size () const
	Return the number of currently contained variable sets.

virtual bool	extract (const Object *obj)
	Allowing the other variant of the extract method.

bool	extract (const Object &obj)
	Allowing the other variant of the extract method.

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.

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< AObject >
	Type of the super class.

Private Attributes
std::vector< std::unique_ptr< ContainedVarSet > >	m_varSets
	Collection of contained variables 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 AObject>
class Belle2::TrackFindingCDC::UnionVarSet< AObject >

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

Definition at line 27 of file UnionVarSet.h.

Member Typedef Documentation

◆ ContainedVarSet

using ContainedVarSet = BaseVarSet<Object>

Type of the contained variable sets.

Definition at line 38 of file UnionVarSet.h.

◆ Object

using Object = AObject

Object type from which variables shall be extracted.

Definition at line 35 of file UnionVarSet.h.

◆ Super

using Super = BaseVarSet<AObject>

private

Type of the super class.

Definition at line 31 of file UnionVarSet.h.

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.

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();
  }
}

◆ clear()

void clear ( )

inline

Remove all contained variable sets.

Definition at line 103 of file UnionVarSet.h.

      {
        m_varSets.clear();
      }

◆ 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/3]

bool extract ( const Object & obj )

inline

Allowing the other variant of the extract method.

Definition at line 56 of file BaseVarSet.h.

      {
        return extract(&obj);
      }

◆ extract() [2/3]

virtual bool extract ( const Object * obj )

inlinevirtual

Allowing the other variant of the extract method.

Reimplemented from BaseVarSet< AObject >.

Definition at line 50 of file BaseVarSet.h.

      {
        return true;
      }

◆ extract() [3/3]

bool extract ( const Object * obj )

inlinefinalvirtual

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

Returns: Indication whether the extraction could be completed successfully.

Reimplemented from BaseVarSet< AObject >.

Definition at line 58 of file UnionVarSet.h.

      {
        bool result = true;
        for (std::unique_ptr<ContainedVarSet>& varSet : m_varSets) {
          result &= varSet->extract(obj);
        }
        return result;
      }

◆ 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< AObject >.

Definition at line 85 of file UnionVarSet.h.

      {
        for (std::unique_ptr<ContainedVarSet>& varSet : m_varSets) {
          MayBePtr<Float_t> found = varSet->find(varName);
          if (found) return found;
        }
        return nullptr;
      }

◆ 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/2]

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

inlineinherited

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/2]

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< AObject >.

Definition at line 71 of file UnionVarSet.h.

      {
        std::vector<Named<Float_t*> > result;
        for (std::unique_ptr<ContainedVarSet>& varSet : m_varSets) {
          std::vector<Named<Float_t*> > extend = varSet->getNamedVariables(prefix);
          result.insert(result.end(), extend.begin(), extend.end());
        }
        return result;
      }

◆ 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 42 of file UnionVarSet.h.

      {
        for (std::unique_ptr<ContainedVarSet>& varSet : m_varSets) {
          this->addProcessingSignalListener(varSet.get());
        }
        Super::initialize();
      }

◆ push_back()

void push_back ( std::unique_ptr< ContainedVarSet > varSet )

inline

Add a variable set to the contained variable sets.

Definition at line 95 of file UnionVarSet.h.

      {
        if (varSet) {
          m_varSets.push_back(std::move(varSet));
        }
      }

◆ size()

size_t size ( ) const

inline

Return the number of currently contained variable sets.

Definition at line 109 of file UnionVarSet.h.

      {
        return m_varSets.size();
      }

◆ 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_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.

◆ m_varSets

std::vector<std::unique_ptr<ContainedVarSet> > m_varSets

private

Collection of contained variables sets.

Definition at line 116 of file UnionVarSet.h.

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

tracking/trackFindingCDC/varsets/include/UnionVarSet.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ContainedVarSet

◆ Object

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ clear()

◆ endRun()

◆ extract() [1/3]

◆ extract() [2/3]

◆ extract() [3/3]

◆ find()

◆ getNamedValues() [1/2]

◆ getNamedValues() [2/2]

◆ getNamedVariables() [1/2]

◆ getNamedVariables() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ push_back()

◆ size()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_varSets