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

#include <VarSet.h>

Inheritance diagram for VarSet< AVarNames >:

Classes
struct	AssignFinite
	Helper construct to assign a finite value to float variables. More...

Public Types
using	Object = typename Super::Object
	Type from which variables should be extracted.

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

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
template<int I>
Float_t	get () const
	Getter for the value of the ith variable. Static version.

template<int I>
Float_t &	var ()
	Reference getter for the value of the ith variable. Static version.

template<int I>
AssignFinite< Float_t >	finitevar ()
	Reference getter for the value of the ith variable. Transforms non-finite values to finite value.

void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Static Protected Member Functions
static constexpr int	named (const char *name)
	Getter for the index from the name.

Private Types
using	Super = BaseVarSet<typename AVarNames::Object>
	Type of the super class.

Private Attributes
FixedSizeNamedFloatTuple< AVarNames >	m_variables
	Memory for nVars floating point values.

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.

Static Private Attributes
static const size_t	nVars = AVarNames::nVars
	Number of floating point values represented by this class.

Detailed Description

template<class AVarNames>
class Belle2::TrackFindingCDC::VarSet< AVarNames >

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

This object template provides the memory and the names of the float values. The filling from the complex object is specialised in the derived class

Template Parameters

AVarNames Class with three containing parameters. Object - The class of the complex object from which to extract the variable. nVars - Number of variables that will be extracted from the complex object. getName(int) - Function to get the name of the variable at the given index

Definition at line 36 of file VarSet.h.

Member Typedef Documentation

◆ Object

template<class AVarNames>

using Object = typename Super::Object

Type from which variables should be extracted.

Definition at line 44 of file VarSet.h.

◆ Super

template<class AVarNames>

using Super = BaseVarSet<typename AVarNames::Object>

private

Type of the super class.

Definition at line 40 of file VarSet.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/2]

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

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 }

◆ find()

template<class AVarNames>

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< AVarNames::Object >.

Definition at line 64 of file VarSet.h.

65 {

66 return m_variables.find(varName);

67 }

◆ finitevar()

template<class AVarNames>

template<int I>

AssignFinite< Float_t > finitevar ( )

inlineprotected

Reference getter for the value of the ith variable. Transforms non-finite values to finite value.

Definition at line 130 of file VarSet.h.

131 {

132 static_assert(I < nVars, "Requested variable index exceeds number of variables.");

133 return AssignFinite<Float_t>(m_variables[I]);

134 }

◆ get()

template<class AVarNames>

template<int I>

Float_t get ( ) const

inlineprotected

Getter for the value of the ith variable. Static version.

Definition at line 85 of file VarSet.h.

86 {

87 static_assert(I < nVars, "Requested variable index exceeds number of variables.");

88 return m_variables.get(I);

89 }

◆ 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 AVarNames>

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< AVarNames::Object >.

Definition at line 55 of file VarSet.h.

56 {

57 return m_variables.getNamedVariables(prefix);

58 }

◆ 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()

void initialize ( )

overrideinherited

Receive and dispatch signal before the start of the event processing.

Definition at line 30 of file CompositeProcessingSignalListener.cc.

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

◆ named()

template<class AVarNames>

static constexpr int named ( const char * name )

inlinestaticconstexprprotected

Getter for the index from the name.

Looks through the associated names and returns the right index if found Returns nVars (one after the last element) if not found.

Parameters

name	Name of the sought variable

Returns: Index of the name, nVars if not found.

Definition at line 78 of file VarSet.h.

79 {

80 return index<nVars>(AVarNames::getName, name);

81 }

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

◆ var()

template<class AVarNames>

template<int I>

Float_t & var ( )

inlineprotected

Reference getter for the value of the ith variable. Static version.

Definition at line 93 of file VarSet.h.

94 {

95 static_assert(I < nVars, "Requested variable index exceeds number of variables.");

96 return m_variables[I];

97 }

Member Data Documentation

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

◆ m_variables

template<class AVarNames>

FixedSizeNamedFloatTuple<AVarNames> m_variables

private

Memory for nVars floating point values.

Definition at line 138 of file VarSet.h.

◆ nVars

template<class AVarNames>

const size_t nVars = AVarNames::nVars

staticprivate

Number of floating point values represented by this class.

Definition at line 48 of file VarSet.h.

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

tracking/trackFindingCDC/varsets/include/VarSet.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Object

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ extract() [1/2]

◆ extract() [2/2]

◆ find()

◆ finitevar()

◆ get()

◆ getNamedValues() [1/2]

◆ getNamedValues() [2/2]

◆ getNamedVariables() [1/2]

◆ getNamedVariables() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ named()

◆ terminate()

◆ var()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_variables

◆ nVars