CbmRoot
Public Member Functions | Private Attributes | List of all members
CbmUnpackTask< TDigi, TAlgo, TParam > Class Template Referenceabstract

CbmRoot (+externals) headers. More...

#include <CbmUnpackTask.h>

Inheritance diagram for CbmUnpackTask< TDigi, TAlgo, TParam >:
[legend]
Collaboration diagram for CbmUnpackTask< TDigi, TAlgo, TParam >:
[legend]

Public Member Functions

 CbmUnpackTask (TString sDigiBranchName, TString sDigiBranchDescr="")
 
 CbmUnpackTask (const CbmUnpackTask &)=delete
 
CbmUnpackTask operator= (const CbmUnpackTask &)=delete
 
 ~CbmUnpackTask ()
 
Bool_t Init ()
 
Bool_t DoUnpack (const fles::Timeslice &ts)
 
void Reset ()
 
void Finish ()
 
void SetParContainers ()
 
Bool_t InitContainers ()
 
Bool_t ReInitContainers ()
 
void AddMsComponentToList (size_t, UShort_t)
 Temp until we change from CbmMcbmUnpack to something else. More...
 
void SetNbMsInTs (size_t, size_t)
 
void SetMonitorMode (Bool_t bFlagIn=kTRUE)
 
void SetIgnoreOverlapMs (Bool_t bFlagIn=kTRUE)
 
void SetWriteOutputFlag (Bool_t bFlagIn)
 Task settings. More...
 
virtual Bool_t DoUnpack (const fles::Timeslice &ts, size_t component)=0
 

Private Attributes

Bool_t fbMonitorMode
 Control flags. More...
 
Bool_t fbDebugMonitorMode
 Switch ON the filling of a minimal set of histograms in the algo. More...
 
Bool_t fbWriteOutput
 Switch ON the filling of a additional set of histograms in the algo. More...
 
uint64_t fulTsCounter = 0
 If ON the output vector of digi is written to disk by FairRoot, otherwise just made available for higher stages. More...
 
std::vector< TDigi > * fvDigiIO
 TS counter, not same as TS index! More...
 
std::vector< CbmErrorMessage > * fvErrorIO
 IO vector of Digis, passed to algo for filling and propagated to framework for output. More...
 
TAlgo * fUnpackerAlgo = nullptr
 IO vector of Errors, passed to algo for filling and propagated to framework for output. More...
 
TString fsDigiBranchName = ""
 pointer to unpacking algo More...
 
TString fsDigiBranchDescr = ""
 

Detailed Description

template<class TDigi, class TAlgo, class TParam>
class CbmUnpackTask< TDigi, TAlgo, TParam >

CbmRoot (+externals) headers.

FairRoot headers Fairsoft (Root, Boost, ...) headers C/C++ headers

Definition at line 26 of file CbmUnpackTask.h.

Constructor & Destructor Documentation

◆ CbmUnpackTask() [1/2]

template<class TDigi , class TAlgo , class TParam >
CbmUnpackTask< TDigi, TAlgo, TParam >::CbmUnpackTask ( TString  sDigiBranchName,
TString  sDigiBranchDescr = "" 
)

◆ CbmUnpackTask() [2/2]

template<class TDigi , class TAlgo , class TParam >
CbmUnpackTask< TDigi, TAlgo, TParam >::CbmUnpackTask ( const CbmUnpackTask< TDigi, TAlgo, TParam > &  )
delete

◆ ~CbmUnpackTask()

template<class TDigi , class TAlgo , class TParam >
CbmUnpackTask< TDigi, TAlgo, TParam >::~CbmUnpackTask ( )

Member Function Documentation

◆ AddMsComponentToList()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::AddMsComponentToList ( size_t  ,
UShort_t   
)
inlinevirtual

Temp until we change from CbmMcbmUnpack to something else.

Implements CbmUnpackTaskBase.

Definition at line 46 of file CbmUnpackTask.h.

◆ DoUnpack() [1/2]

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::DoUnpack ( const fles::Timeslice &  ts)

◆ DoUnpack() [2/2]

virtual Bool_t CbmUnpackTaskBase::DoUnpack ( const fles::Timeslice &  ts,
size_t  component 
)
pure virtualinherited

◆ Finish()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::Finish ( )
virtual

Implements CbmUnpackTaskBase.

◆ Init()

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::Init ( )
virtual

Implements CbmUnpackTaskBase.

◆ InitContainers()

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::InitContainers ( )
virtual

Reimplemented from CbmUnpackTaskBase.

◆ operator=()

template<class TDigi , class TAlgo , class TParam >
CbmUnpackTask CbmUnpackTask< TDigi, TAlgo, TParam >::operator= ( const CbmUnpackTask< TDigi, TAlgo, TParam > &  )
delete

◆ ReInitContainers()

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::ReInitContainers ( )
virtual

Reimplemented from CbmUnpackTaskBase.

◆ Reset()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::Reset ( )
virtual

Implements CbmUnpackTaskBase.

◆ SetIgnoreOverlapMs()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::SetIgnoreOverlapMs ( Bool_t  bFlagIn = kTRUE)

◆ SetMonitorMode()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::SetMonitorMode ( Bool_t  bFlagIn = kTRUE)
inline

Definition at line 49 of file CbmUnpackTask.h.

References CbmUnpackTask< TDigi, TAlgo, TParam >::fbMonitorMode.

◆ SetNbMsInTs()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::SetNbMsInTs ( size_t  ,
size_t   
)
inlinevirtual

Implements CbmUnpackTaskBase.

Definition at line 47 of file CbmUnpackTask.h.

◆ SetParContainers()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::SetParContainers ( )
virtual

Implements CbmUnpackTaskBase.

◆ SetWriteOutputFlag()

template<class TDigi , class TAlgo , class TParam >
void CbmUnpackTask< TDigi, TAlgo, TParam >::SetWriteOutputFlag ( Bool_t  bFlagIn)
inline

Task settings.

Definition at line 57 of file CbmUnpackTask.h.

References CbmUnpackTask< TDigi, TAlgo, TParam >::fbWriteOutput.

Member Data Documentation

◆ fbDebugMonitorMode

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::fbDebugMonitorMode
private
Initial value:
=
kFALSE

Switch ON the filling of a minimal set of histograms in the algo.

Definition at line 63 of file CbmUnpackTask.h.

◆ fbMonitorMode

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::fbMonitorMode
private
Initial value:
=
kFALSE

Control flags.

Definition at line 61 of file CbmUnpackTask.h.

Referenced by CbmUnpackTask< TDigi, TAlgo, TParam >::SetMonitorMode().

◆ fbWriteOutput

template<class TDigi , class TAlgo , class TParam >
Bool_t CbmUnpackTask< TDigi, TAlgo, TParam >::fbWriteOutput
private
Initial value:
=
kTRUE

Switch ON the filling of a additional set of histograms in the algo.

Definition at line 65 of file CbmUnpackTask.h.

Referenced by CbmUnpackTask< TDigi, TAlgo, TParam >::SetWriteOutputFlag().

◆ fsDigiBranchDescr

template<class TDigi , class TAlgo , class TParam >
TString CbmUnpackTask< TDigi, TAlgo, TParam >::fsDigiBranchDescr = ""
private

Definition at line 86 of file CbmUnpackTask.h.

◆ fsDigiBranchName

template<class TDigi , class TAlgo , class TParam >
TString CbmUnpackTask< TDigi, TAlgo, TParam >::fsDigiBranchName = ""
private

pointer to unpacking algo

Names for framework objects search

Definition at line 85 of file CbmUnpackTask.h.

◆ fulTsCounter

template<class TDigi , class TAlgo , class TParam >
uint64_t CbmUnpackTask< TDigi, TAlgo, TParam >::fulTsCounter = 0
private

If ON the output vector of digi is written to disk by FairRoot, otherwise just made available for higher stages.

Statistics & first TS rejection

Definition at line 69 of file CbmUnpackTask.h.

◆ fUnpackerAlgo

template<class TDigi , class TAlgo , class TParam >
TAlgo* CbmUnpackTask< TDigi, TAlgo, TParam >::fUnpackerAlgo = nullptr
private

IO vector of Errors, passed to algo for filling and propagated to framework for output.

Histograms for vector monitoring? Processing algo

Definition at line 82 of file CbmUnpackTask.h.

◆ fvDigiIO

template<class TDigi , class TAlgo , class TParam >
std::vector<TDigi>* CbmUnpackTask< TDigi, TAlgo, TParam >::fvDigiIO
private
Initial value:
=
nullptr

TS counter, not same as TS index!

Input/Output vector

Definition at line 72 of file CbmUnpackTask.h.

◆ fvErrorIO

template<class TDigi , class TAlgo , class TParam >
std::vector<CbmErrorMessage>* CbmUnpackTask< TDigi, TAlgo, TParam >::fvErrorIO
private
Initial value:
=
nullptr

IO vector of Digis, passed to algo for filling and propagated to framework for output.

Definition at line 74 of file CbmUnpackTask.h.

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