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

#include <VarSet.h>

Inheritance diagram for VarSet< AVarNames >:

[legend]

Collaboration diagram for VarSet< AVarNames >:

[legend]

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

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
constexpr static int	named (const char *name)
	Getter for the index from the name. More...

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

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

Definition at line 64 of file VarSet.h.

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

◆ named()

constexpr static 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.

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

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

Member Function Documentation

◆ extract()

◆ find()

◆ getNamedValues()

◆ named()

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