Generic class that generates the same variables from a each of a pair of instances. More...

#include <RelationVarSet.h>

Inheritance diagram for RelationVarSet< ABaseVarSet >:

Public Types
using	BaseObject = typename ABaseVarSet::Object
	Object type from which the variables shall be extracted.

using	Object
	Object type from which variables shall be extracted.

Public Member Functions
void	initialize () override
	Initialize the variable set before event processing.

bool	extract (const Relation< const BaseObject > *obj) override
	Main method that extracts the variable values from the complex object.

bool	extract (const Relation< const BaseObject > &obj)
	Method for extraction from an object instead of a pointer.

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.

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.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list.

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<Relation<const typename ABaseVarSet::Object> >
	Type of the base class.

Private Attributes
std::string	m_firstPrefix = "first_"
	Prefix for all variable in the variable set of the first element of the pair.

ABaseVarSet	m_firstVarSet
	VarSet for the first element of the set.

std::string	m_secondPrefix = "second_"
	Prefix for all variable in the variable set of the second element of the pair.

ABaseVarSet	m_secondVarSet
	VarSet for the second element of the set.

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized
	Flag to keep track whether initialization happened before.

bool	m_terminated
	Flag to keep track whether termination happened before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class ABaseVarSet>
class Belle2::TrackFindingCDC::RelationVarSet< ABaseVarSet >

Generic class that generates the same variables from a each of a pair of instances.

Definition at line 27 of file RelationVarSet.h.

Member Typedef Documentation

◆ BaseObject

template<class ABaseVarSet>

using BaseObject = typename ABaseVarSet::Object

Object type from which the variables shall be extracted.

Definition at line 34 of file RelationVarSet.h.

◆ Object

using Object

inherited

Object type from which variables shall be extracted.

Definition at line 38 of file BaseVarSet.h.

◆ Super

template<class ABaseVarSet>

using Super = BaseVarSet<Relation<const typename ABaseVarSet::Object> >

private

Type of the base class.

Definition at line 30 of file RelationVarSet.h.

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 53 of file CompositeProcessingSignalListener.cc.

56{

57 m_subordinaryProcessingSignalListeners.push_back(psl);

58}

Belle2::TrackFindingCDC::BaseVarSet

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

Definition BaseVarSet.h:34

◆ beginEvent()

void beginEvent ( )

overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

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

◆ exposeParameters()

virtual void exposeParameters	(	ModuleParamList *	moduleParamList,
		const std::string &	prefix )

inlinevirtualinherited

Expose the set of parameters of the filter to the module parameter list.

Parameters

moduleParamList	Module parameter list to add the new parameters to
prefix	Prefix (or sometimes postfix) to be added to all nely added parameters.

Definition at line 47 of file CompositeProcessingSignalListener.h.

49 {};

◆ extract() [1/4]

bool extract ( const Object & obj )

inlineinherited

Method for extraction from an object instead of a pointer.

Definition at line 57 of file BaseVarSet.h.

58 {

59 return extract(&obj);

60 }

◆ extract() [2/4]

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 51 of file BaseVarSet.h.

52 {

53 return true;

54 }

◆ extract() [3/4]

template<class ABaseVarSet>

bool extract ( const Relation< const BaseObject > & obj )

inline

Method for extraction from an object instead of a pointer.

Definition at line 58 of file RelationVarSet.h.

59 {

60 return extract(&obj);

61 }

◆ extract() [4/4]

template<class ABaseVarSet>

bool extract ( const Relation< const BaseObject > * obj )

inlineoverride

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

Definition at line 49 of file RelationVarSet.h.

      {
        assert(obj);
        bool firstExtracted = m_firstVarSet.extract(obj->first);
        bool secondExtracted = m_secondVarSet.extract(obj->second);
        return firstExtracted and secondExtracted;
      }

◆ find()

template<class ABaseVarSet>

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< Relation< const ABaseVarSet::Object > >.

Definition at line 79 of file RelationVarSet.h.

      {
        // it is hard to do this with string::compare as cppcheck recommends
        // cppcheck-suppress stlIfStrFind
        if (0 == varName.find(m_firstPrefix)) {
          std::string varNameWithoutPrefix = varName.substr(m_firstPrefix.size());
          MayBePtr<Float_t> found = m_firstVarSet.find(varNameWithoutPrefix);
          if (found) return found;
        }
 
        // it is hard to do this with string::compare as cppcheck recommends
        // cppcheck-suppress stlIfStrFind
        if (0 == varName.find(m_secondPrefix)) {
          std::string varNameWithoutPrefix = varName.substr(m_secondPrefix.size());
          MayBePtr<Float_t> found = m_secondVarSet.find(varNameWithoutPrefix);
          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 96 of file BaseVarSet.h.

97 {

98 const std::string prefix = "";

99 return this->getNamedValues(prefix);

100 }

◆ 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 84 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 74 of file BaseVarSet.h.

75 {

76 const std::string prefix = "";

77 return this->getNamedVariables(prefix);

78 }

◆ getNamedVariables() [2/2]

template<class ABaseVarSet>

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< Relation< const ABaseVarSet::Object > >.

Definition at line 67 of file RelationVarSet.h.

      {
        std::vector<Named<Float_t*> > result = m_firstVarSet.getNamedVariables(prefix + m_firstPrefix);
        std::vector<Named<Float_t*> > extend = m_secondVarSet.getNamedVariables(prefix + m_secondPrefix);
        result.insert(result.end(), extend.begin(), extend.end());
        return result;
      }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{

62 return m_subordinaryProcessingSignalListeners.size();

63}

◆ initialize()

template<class ABaseVarSet>

void initialize ( )

inlineoverridevirtual

Initialize the variable set before event processing.

Can be specialised if the derived variable set has setup work to do.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 41 of file RelationVarSet.h.

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

◆ terminate()

void terminate ( )

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

◆ m_firstPrefix

template<class ABaseVarSet>

std::string m_firstPrefix = "first_"

private

Prefix for all variable in the variable set of the first element of the pair.

Definition at line 102 of file RelationVarSet.h.

◆ m_firstVarSet

template<class ABaseVarSet>

ABaseVarSet m_firstVarSet

private

VarSet for the first element of the set.

Definition at line 105 of file RelationVarSet.h.

◆ m_initialized

bool m_initialized

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_secondPrefix

template<class ABaseVarSet>

std::string m_secondPrefix = "second_"

private

Prefix for all variable in the variable set of the second element of the pair.

Definition at line 108 of file RelationVarSet.h.

◆ m_secondVarSet

template<class ABaseVarSet>

ABaseVarSet m_secondVarSet

private

VarSet for the second element of the set.

Definition at line 111 of file RelationVarSet.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated

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/RelationVarSet.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BaseObject

◆ Object

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ extract() [1/4]

◆ extract() [2/4]

◆ extract() [3/4]

◆ extract() [4/4]

◆ find()

◆ getNamedValues() [1/2]

◆ getNamedValues() [2/2]

◆ getNamedVariables() [1/2]

◆ getNamedVariables() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_firstPrefix

◆ m_firstVarSet

◆ m_initialized

◆ m_initializedAs

◆ m_secondPrefix

◆ m_secondVarSet

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated