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

Member Function Documentation

extract()

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.

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

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.

initialize()

void initialize ( void  )

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.

---

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

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