CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CbmStar2019Algo< T > Class Template Referenceabstract

#include <CbmStar2019Algo.h>

Inheritance diagram for CbmStar2019Algo< T >:
[legend]

Public Member Functions

 CbmStar2019Algo ()
 
virtual ~CbmStar2019Algo ()=default
 
 CbmStar2019Algo (const CbmStar2019Algo &)=delete
 
CbmStar2019Algo & operator= (const CbmStar2019Algo &)=delete
 
virtual Bool_t Init ()=0
 
virtual void Reset ()=0
 
virtual void Finish ()=0
 
virtual Bool_t ProcessTs (const fles::Timeslice &ts)=0
 
virtual Bool_t ProcessTs (const fles::Timeslice &ts, size_t component)=0
 
virtual Bool_t ProcessMs (const fles::Timeslice &ts, size_t uMsCompIdx, size_t uMsIdx)=0
 
virtual Bool_t InitContainers ()=0
 
virtual Bool_t ReInitContainers ()=0
 
virtual TList * GetParList ()=0
 
virtual void SetParameter (std::string)
 
virtual std::string GetParameter (std::string)
 
void AddHistoToVector (TNamed *pointer, std::string sFolder="")
 For monitor algos.
 
std::vector< std::pair< TNamed *, std::string > > GetHistoVector ()
 
void AddCanvasToVector (TCanvas *pointer, std::string sFolder="")
 
std::vector< std::pair< TCanvas *, std::string > > GetCanvasVector ()
 
void ClearVector ()
 For unpacker algos.
 
std::vector< T > & GetVector ()
 
void ClearErrorVector ()
 
std::vector< CbmErrorMessage > & GetErrorVector ()
 
void SetIgnoreOverlapMs (Bool_t bFlagIn=kTRUE)
 Control flags.
 

Protected Member Functions

Bool_t CheckParameterValidity (std::string, std::string)
 Map of parameter name and type.
 

Protected Attributes

TList * fParCList
 Parameter management.
 
std::vector< size_t > fvMsComponentsList
 Parameters related to FLES containers.
 
size_t fuNbCoreMsPerTs
 
size_t fuNbOverMsPerTs
 
size_t fuNbMsLoop
 
Bool_t fbIgnoreOverlapMs
 
Double_t fdMsSizeInNs
 /‍** Ignore Overlap Ms: all fuOverlapMsNb MS at the end of timeslice **‍/
 
Double_t fdTsCoreSizeInNs
 Size of a single MS, [nanoseconds].
 
Double_t fdTsFullSizeInNs
 Total size of the core MS in a TS, [nanoseconds].
 
std::vector< std::pair< TNamed *, std::string > > fvpAllHistoPointers
 Total size of the core MS in a TS, [nanoseconds].
 
std::vector< std::pair< TCanvas *, std::string > > fvpAllCanvasPointers
 Vector of pointers to histograms + optional folder name.
 
std::vector< T > fDigiVect
 Vector of pointers to canvases + optional folder name.
 
std::vector< CbmErrorMessage > fErrVect = {}
 
std::map< std::string, std::string > fParameterMap
 For any algo.
 

Detailed Description

template<typename T>
class CbmStar2019Algo< T >

Definition at line 49 of file CbmStar2019Algo.h.

Constructor & Destructor Documentation

◆ CbmStar2019Algo() [1/2]

template<typename T>
CbmStar2019Algo< T >::CbmStar2019Algo ( )
inline

Definition at line 51 of file CbmStar2019Algo.h.

References fbIgnoreOverlapMs, fDigiVect, fdMsSizeInNs, fdTsCoreSizeInNs, fdTsFullSizeInNs, fParameterMap, fParCList, fuNbCoreMsPerTs, fuNbMsLoop, fuNbOverMsPerTs, fvMsComponentsList, and fvpAllHistoPointers.

Referenced by CbmStar2019Algo(), and operator=().

◆ ~CbmStar2019Algo()

template<typename T>
virtual CbmStar2019Algo< T >::~CbmStar2019Algo ( )
virtualdefault

◆ CbmStar2019Algo() [2/2]

template<typename T>
CbmStar2019Algo< T >::CbmStar2019Algo ( const CbmStar2019Algo< T > & )
delete

References CbmStar2019Algo().

Member Function Documentation

◆ AddCanvasToVector()

template<typename T>
void CbmStar2019Algo< T >::AddCanvasToVector ( TCanvas * pointer,
std::string sFolder = "" )
inline

Definition at line 88 of file CbmStar2019Algo.h.

References fvpAllCanvasPointers.

◆ AddHistoToVector()

template<typename T>
void CbmStar2019Algo< T >::AddHistoToVector ( TNamed * pointer,
std::string sFolder = "" )
inline

For monitor algos.

Definition at line 83 of file CbmStar2019Algo.h.

References fvpAllHistoPointers.

◆ CheckParameterValidity()

template<typename T>
Bool_t CbmStar2019Algo< T >::CheckParameterValidity ( std::string ,
std::string  )
inlineprotected

Map of parameter name and type.

Definition at line 140 of file CbmStar2019Algo.h.

◆ ClearErrorVector()

template<typename T>
void CbmStar2019Algo< T >::ClearErrorVector ( )
inline

Definition at line 97 of file CbmStar2019Algo.h.

References fErrVect.

◆ ClearVector()

template<typename T>
void CbmStar2019Algo< T >::ClearVector ( )
inline

For unpacker algos.

Definition at line 95 of file CbmStar2019Algo.h.

References fDigiVect.

◆ Finish()

template<typename T>
virtual void CbmStar2019Algo< T >::Finish ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ GetCanvasVector()

template<typename T>
std::vector< std::pair< TCanvas *, std::string > > CbmStar2019Algo< T >::GetCanvasVector ( )
inline

Definition at line 92 of file CbmStar2019Algo.h.

References fvpAllCanvasPointers.

◆ GetErrorVector()

template<typename T>
std::vector< CbmErrorMessage > & CbmStar2019Algo< T >::GetErrorVector ( )
inline

Definition at line 98 of file CbmStar2019Algo.h.

References fErrVect.

◆ GetHistoVector()

template<typename T>
std::vector< std::pair< TNamed *, std::string > > CbmStar2019Algo< T >::GetHistoVector ( )
inline

Definition at line 87 of file CbmStar2019Algo.h.

References fvpAllHistoPointers.

◆ GetParameter()

template<typename T>
virtual std::string CbmStar2019Algo< T >::GetParameter ( std::string )
inlinevirtual

Definition at line 80 of file CbmStar2019Algo.h.

◆ GetParList()

template<typename T>
virtual TList * CbmStar2019Algo< T >::GetParList ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ GetVector()

template<typename T>
std::vector< T > & CbmStar2019Algo< T >::GetVector ( )
inline

Definition at line 96 of file CbmStar2019Algo.h.

References fDigiVect.

◆ Init()

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::Init ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ InitContainers()

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::InitContainers ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ operator=()

template<typename T>
CbmStar2019Algo & CbmStar2019Algo< T >::operator= ( const CbmStar2019Algo< T > & )
delete

References CbmStar2019Algo().

◆ ProcessMs()

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::ProcessMs ( const fles::Timeslice & ts,
size_t uMsCompIdx,
size_t uMsIdx )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ ProcessTs() [1/2]

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::ProcessTs ( const fles::Timeslice & ts)
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ ProcessTs() [2/2]

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::ProcessTs ( const fles::Timeslice & ts,
size_t component )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ ReInitContainers()

template<typename T>
virtual Bool_t CbmStar2019Algo< T >::ReInitContainers ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ Reset()

template<typename T>
virtual void CbmStar2019Algo< T >::Reset ( )
pure virtual

Implemented in CbmCosy2019MonitorAlgoHodo, CbmCosy2019UnpackerAlgoHodo, CbmMcbm2018MonitorAlgoBmon, CbmMcbm2018MonitorAlgoMuchLite, CbmMcbm2018MonitorAlgoPsd, CbmMcbm2018MonitorAlgoTof, CbmMcbm2018MonitorAlgoTofPulser, CbmMcbm2018UnpackerAlgoMuch, CbmMcbm2018UnpackerAlgoPsd, CbmMcbm2018UnpackerAlgoRich2020, CbmMcbm2018UnpackerAlgoRich, CbmMcbm2018UnpackerAlgoSts, CbmMcbm2018UnpackerAlgoTof, CbmMcbm2018UnpackerAlgoTrdR, CbmMcbmSpillFindAlgo, CbmStar2019EventBuilderEtofAlgo, CbmStar2019MonitorAlgo, and CbmStar2019MonitorPulserAlgo.

◆ SetIgnoreOverlapMs()

template<typename T>
void CbmStar2019Algo< T >::SetIgnoreOverlapMs ( Bool_t bFlagIn = kTRUE)
inline

Control flags.

Definition at line 101 of file CbmStar2019Algo.h.

References fbIgnoreOverlapMs.

◆ SetParameter()

template<typename T>
virtual void CbmStar2019Algo< T >::SetParameter ( std::string )
inlinevirtual

Definition at line 79 of file CbmStar2019Algo.h.

Member Data Documentation

◆ fbIgnoreOverlapMs

template<typename T>
Bool_t CbmStar2019Algo< T >::fbIgnoreOverlapMs
protected

Definition at line 112 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo(), and SetIgnoreOverlapMs().

◆ fDigiVect

template<typename T>
std::vector<T> CbmStar2019Algo< T >::fDigiVect
protected

Vector of pointers to canvases + optional folder name.

For unpacker algos

Definition at line 134 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo(), ClearVector(), and GetVector().

◆ fdMsSizeInNs

template<typename T>
Double_t CbmStar2019Algo< T >::fdMsSizeInNs
protected

/‍** Ignore Overlap Ms: all fuOverlapMsNb MS at the end of timeslice **‍/

Definition at line 113 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fdTsCoreSizeInNs

template<typename T>
Double_t CbmStar2019Algo< T >::fdTsCoreSizeInNs
protected

Size of a single MS, [nanoseconds].

Definition at line 114 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fdTsFullSizeInNs

template<typename T>
Double_t CbmStar2019Algo< T >::fdTsFullSizeInNs
protected

Total size of the core MS in a TS, [nanoseconds].

Definition at line 115 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fErrVect

template<typename T>
std::vector<CbmErrorMessage> CbmStar2019Algo< T >::fErrVect = {}
protected

Definition at line 135 of file CbmStar2019Algo.h.

Referenced by ClearErrorVector(), and GetErrorVector().

◆ fParameterMap

template<typename T>
std::map<std::string, std::string> CbmStar2019Algo< T >::fParameterMap
protected

For any algo.

Definition at line 138 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fParCList

template<typename T>
TList* CbmStar2019Algo< T >::fParCList
protected

Parameter management.

Definition at line 105 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fuNbCoreMsPerTs

template<typename T>
size_t CbmStar2019Algo< T >::fuNbCoreMsPerTs
protected

Definition at line 109 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fuNbMsLoop

template<typename T>
size_t CbmStar2019Algo< T >::fuNbMsLoop
protected

Definition at line 111 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fuNbOverMsPerTs

template<typename T>
size_t CbmStar2019Algo< T >::fuNbOverMsPerTs
protected

Definition at line 110 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fvMsComponentsList

template<typename T>
std::vector<size_t> CbmStar2019Algo< T >::fvMsComponentsList
protected

Parameters related to FLES containers.

Definition at line 108 of file CbmStar2019Algo.h.

Referenced by CbmStar2019Algo().

◆ fvpAllCanvasPointers

template<typename T>
std::vector<std::pair<TCanvas*, std::string> > CbmStar2019Algo< T >::fvpAllCanvasPointers
protected

Vector of pointers to histograms + optional folder name.

Definition at line 131 of file CbmStar2019Algo.h.

Referenced by AddCanvasToVector(), and GetCanvasVector().

◆ fvpAllHistoPointers

template<typename T>
std::vector<std::pair<TNamed*, std::string> > CbmStar2019Algo< T >::fvpAllHistoPointers
protected

Total size of the core MS in a TS, [nanoseconds].

For monitor algos => Pointers should be filled with TH1*, TH2*, TProfile*, ... ==> To check if object N is of type T, use "T ObjectPointer = dynamic_cast<T>( fvpAllHistoPointers[N].first );" and check for nullptr ==> To get back the original class name use "fvpAllHistoPointers[N].first->ClassName()" which returns a const char * (e.g. "TH1I") ===> Usage example with feeding a THttpServer: ===> #include "TH2.h" ===> std::string sClassName = vHistos[ uHisto ].first.ClassName(); ===> if( !strncmp( sClassName, "TH1", 3 ) ) ===> server->Register( vHistos[ uHisto ].second.data(), dynamic_cast< TH1 * >(vHistos[ uHisto ].first) ); ===> else if( !strncmp( sClassName, "TH2", 3 ) ) ===> server->Register( vHistos[ uHisto ].second.data(), dynamic_cast< TH2 * >(vHistos[ uHisto ].first) );

Definition at line 129 of file CbmStar2019Algo.h.

Referenced by AddHistoToVector(), CbmStar2019Algo(), and GetHistoVector().

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