Belle II Software  release-05-02-19
RelationVarSet< ABaseVarSet > Class Template Reference

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

#include <RelationVarSet.h>

Inheritance diagram for RelationVarSet< ABaseVarSet >:
Collaboration diagram for RelationVarSet< ABaseVarSet >:

Public Types

using BaseObject = typename ABaseVarSet::Object
 Object type from which the variables shall be extracted.
 
using Object = Relation< const ABaseVarSet::Object >
 Object type from which variables shall be extracted.
 

Public Member Functions

void initialize () override
 Initialize the variable set before event processing. More...
 
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 implementaton returns empty vector.
 
MayBePtr< Float_t > find (const std::string &varName) override
 Pointer to the variable with the given name. More...
 
virtual bool extract (const Object *obj __attribute__((unused)))
 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 __attribute__((unused)))
 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.
 
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< 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 = 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 ABaseVarSet>
class Belle2::TrackFindingCDC::RelationVarSet< ABaseVarSet >

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

Definition at line 37 of file RelationVarSet.h.

Member Function Documentation

◆ extract()

virtual bool extract ( const Object *obj  __attribute__(unused))
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.

Definition at line 58 of file BaseVarSet.h.

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

Definition at line 89 of file RelationVarSet.h.

93  {
94  std::string varNameWithoutPrefix = varName.substr(m_secondPrefix.size());
95  MayBePtr<Float_t> found = m_secondVarSet.find(varNameWithoutPrefix);
96  if (found) return found;
97  }
98 
99  return nullptr;
100  }
101 
102  private:
104  std::string m_firstPrefix = "first_";
105 
107  ABaseVarSet m_firstVarSet;
108 

◆ getNamedValues()

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

Getter for a map of names to float values.

Parameters
prefixName prefix to apply to all variable names.

Definition at line 90 of file BaseVarSet.h.

◆ getNamedVariables()

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

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

Parameters
prefixName prefix to apply to all variable names.

Definition at line 74 of file BaseVarSet.h.

◆ initialize()

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


The documentation for this class was generated from the following file:
Belle2::TrackFindingCDC::RelationVarSet::m_firstPrefix
std::string m_firstPrefix
Prefix for all variable in the variable set of the first element of the pair.
Definition: RelationVarSet.h:112
Belle2::TrackFindingCDC::RelationVarSet::m_secondVarSet
ABaseVarSet m_secondVarSet
VarSet for the second element of the set.
Definition: RelationVarSet.h:121
Belle2::TrackFindingCDC::RelationVarSet::m_secondPrefix
std::string m_secondPrefix
Prefix for all variable in the variable set of the second element of the pair.
Definition: RelationVarSet.h:118
Belle2::TrackFindingCDC::RelationVarSet::m_firstVarSet
ABaseVarSet m_firstVarSet
VarSet for the first element of the set.
Definition: RelationVarSet.h:115