Base class for storing an algorithm determining the data one wants to have. More...

#include <AnalyzingAlgorithmBase.h>

Inheritance diagram for AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >:

[legend]

Classes
struct	TcPair
	minimal struct for keeping track which tc is which More...

Public Member Functions
	BELLE2_DEFINE_EXCEPTION (No_refTC_Attached, "To given testTC no refTC was attached, could not provide valid data for algorithm - no value returned!")
	this exception is thrown if m_storeRefTCDataForTestTC is true and no refTC could be found

	AnalyzingAlgorithmBase ()
	constructor

virtual	~AnalyzingAlgorithmBase ()
	virtual destructor - derived classes need to write their own destructors if any other data members are added.

bool	operator== (const AnalyzingAlgorithmBase &b) const
	operator for comparison.

AlgoritmType::Type	getID () const
	returns unique ID

std::string	getIDName () const
	returns unique ID as a string

virtual DataType	calcData (const TCInfoType &)
	virtual class to calculate data. More...

Static Public Member Functions
static VectorType &	getOrigin ()
	returns current value for the origin

static void	setOrigin (VectorType newOrigin)
	set origin for all inherited classes

static bool	willRefTCdataBeUsed4TestTCs ()
	returns current choice for behavior of algorithms in terms of storing reference or testData for successfully matched TCs

static void	setWillRefTCdataBeUsed4TestTCs (bool newBehavior)
	set behavior of algorithms in terms of storing reference or testData for successfully matched TCs

Protected Member Functions
	AnalyzingAlgorithmBase (const AlgoritmType::Type &newID)
	constructor used for inheriting classes

	AnalyzingAlgorithmBase (const std::string &newID)
	constructor used for inheriting classes

	AnalyzingAlgorithmBase (const AnalyzingAlgorithmBase &algo)=delete
	copy constructor should not be used so delete it

AnalyzingAlgorithmBase &	operator= (const AnalyzingAlgorithmBase &algo)=delete
	also assignement constructor should not be used

virtual const TCInfoType &	chooseCorrectTC (const TCInfoType &aTC) const
	virtual class to determine the correct TC to be used for algorithm calculation. More...

virtual const TcPair	chooseCorrectPairOfTCs (const TCInfoType &aTC) const
	makes sure that TcPair.refTC and .testTC are correctly set - throws exeption if there are problems

Protected Attributes
AlgoritmType::Type	m_iD
	carries unique ID

Static Protected Attributes
static VectorType	s_origin = VectorType(0, 0, 0)
	stores the origin used for some calculations, can be set here More...

static bool	m_storeRefTCDataForTestTC = false
	if true, for testTC the values of attached refTC will be stored instead of own values. More...

Detailed Description

template<class DataType, class TCInfoType, class VectorType>
class Belle2::AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >

Base class for storing an algorithm determining the data one wants to have.

Definition at line 31 of file AnalyzingAlgorithmBase.h.

Member Function Documentation

◆ calcData()

virtual DataType calcData ( const TCInfoType & )

inlinevirtual

virtual class to calculate data.

takes two TCInfos

Definition at line 153 of file AnalyzingAlgorithmBase.h.

     {
       B2ERROR(" AnalyzingAlgorithmBase::calcData: if you can see this, the code tried to return the actual baseClass instead of the inherited ones - this is unintended behavior!");
       return DataType();
     }

◆ chooseCorrectTC()

virtual const TCInfoType& chooseCorrectTC ( const TCInfoType & aTC ) const

inlineprotectedvirtual

virtual class to determine the correct TC to be used for algorithm calculation.

throws exeption if there are problems. More explanations @ m_storeRefTCDataForTestTC.

Definition at line 84 of file AnalyzingAlgorithmBase.h.

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

tracking/trackFindingVXD/analyzingTools/algorithms/include/AnalyzingAlgorithmBase.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<class DataType, class TCInfoType, class VectorType> class Belle2::AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >

Member Function Documentation

◆ calcData()

◆ chooseCorrectTC()

template<class DataType, class TCInfoType, class VectorType>
class Belle2::AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >