CbmRoot
CbmDigitizeInfo Class Reference

Auxiliary class for CbmDigitize. More...

#include <CbmDigitizeInfo.h>

Inheritance diagram for CbmDigitizeInfo:
[legend]
Collaboration diagram for CbmDigitizeInfo:
[legend]

Public Member Functions

 CbmDigitizeInfo (ECbmModuleId system, TString branch="", CbmDigitizeBase *digitizer=nullptr, Bool_t present=kFALSE, Bool_t active=kTRUE, Bool_t persistent=kTRUE)
 Constructor. More...
 
virtual ~CbmDigitizeInfo ()
 
TString GetBranchName () const
 Get input branch name @value Input branch name. More...
 
CbmDigitizeBaseGetDigitizer () const
 Get digitizer @value Pointer to digitizer instance. More...
 
Bool_t IsActive () const
 Activity flag @value If kTRUE, if digitizer will be active. More...
 
Bool_t IsPresent () const
 Data presence flag @value kTRUE if input branch is present in the tree. More...
 
void SetActive (Bool_t choice=kTRUE)
 Set activity flag. More...
 
void SetBranchName (TString branch)
 Set input branch name. More...
 
void SetDigitizer (CbmDigitizeBase *digitizer)
 Set digitizer instance. More...
 
void SetPersistent (Bool_t choice=kTRUE)
 Set persistence flag. More...
 
void SetPresent (Bool_t choice=kTRUE)
 Set data presence flag. More...
 
std::string ToString () const
 Info to string. More...
 

Private Member Functions

 CbmDigitizeInfo (const CbmDigitizeInfo &)=delete
 Copy constructor forbidden. More...
 
CbmDigitizeInfo operator= (const CbmDigitizeInfo &)=delete
 Assignment operator forbidden. More...
 
 ClassDef (CbmDigitizeInfo, 2)
 

Private Attributes

ECbmModuleId fSystem
 
TString fBranch
 
CbmDigitizeBasefDigitizer
 
Bool_t fPresent
 
Bool_t fActive
 
Bool_t fPersistent
 

Detailed Description

Auxiliary class for CbmDigitize.

The class CbmDigitizeInfo keeps information on the digitisation for a detector system, like the instance of the digitizer, the input branch name (MCPoint), and flags indicating the presence of the input branch and the persistence of the output data (digis).

Definition at line 23 of file CbmDigitizeInfo.h.

Constructor & Destructor Documentation

◆ CbmDigitizeInfo() [1/2]

CbmDigitizeInfo::CbmDigitizeInfo ( ECbmModuleId  system,
TString  branch = "",
CbmDigitizeBase digitizer = nullptr,
Bool_t  present = kFALSE,
Bool_t  active = kTRUE,
Bool_t  persistent = kTRUE 
)
inline

Constructor.

Parameters
systemSystem ID (ECbmModuleId)
presentkTRUE if MC data branch is present
activeDigitizer will be run if kTRUE
persistentOutput data will be persistent if kTRUE
branchName of MCPoint branch as input
digitizerPointer to digitizer instance

Definition at line 34 of file CbmDigitizeInfo.h.

◆ ~CbmDigitizeInfo()

virtual CbmDigitizeInfo::~CbmDigitizeInfo ( )
inlinevirtual

Destructor

Definition at line 49 of file CbmDigitizeInfo.h.

◆ CbmDigitizeInfo() [2/2]

CbmDigitizeInfo::CbmDigitizeInfo ( const CbmDigitizeInfo )
privatedelete

Copy constructor forbidden.

Member Function Documentation

◆ ClassDef()

CbmDigitizeInfo::ClassDef ( CbmDigitizeInfo  ,
 
)
private

◆ GetBranchName()

TString CbmDigitizeInfo::GetBranchName ( ) const
inline

Get input branch name @value Input branch name.

Definition at line 55 of file CbmDigitizeInfo.h.

References fBranch.

◆ GetDigitizer()

CbmDigitizeBase* CbmDigitizeInfo::GetDigitizer ( ) const
inline

Get digitizer @value Pointer to digitizer instance.

Definition at line 61 of file CbmDigitizeInfo.h.

References fDigitizer.

◆ IsActive()

Bool_t CbmDigitizeInfo::IsActive ( ) const
inline

Activity flag @value If kTRUE, if digitizer will be active.

Definition at line 67 of file CbmDigitizeInfo.h.

References fActive.

◆ IsPresent()

Bool_t CbmDigitizeInfo::IsPresent ( ) const
inline

Data presence flag @value kTRUE if input branch is present in the tree.

Definition at line 73 of file CbmDigitizeInfo.h.

References fPresent.

◆ operator=()

CbmDigitizeInfo CbmDigitizeInfo::operator= ( const CbmDigitizeInfo )
privatedelete

Assignment operator forbidden.

◆ SetActive()

void CbmDigitizeInfo::SetActive ( Bool_t  choice = kTRUE)
inline

Set activity flag.

Parameters
choiceIf kTRUE, the digitizer will be active.

Definition at line 78 of file CbmDigitizeInfo.h.

References fActive.

◆ SetBranchName()

void CbmDigitizeInfo::SetBranchName ( TString  branch)
inline

Set input branch name.

Parameters
branchName of input branch (MCPoint array)

Definition at line 84 of file CbmDigitizeInfo.h.

References fBranch.

◆ SetDigitizer()

void CbmDigitizeInfo::SetDigitizer ( CbmDigitizeBase digitizer)
inline

Set digitizer instance.

Parameters
digitizerPointer to digitizer instance

Definition at line 90 of file CbmDigitizeInfo.h.

References fDigitizer.

◆ SetPersistent()

void CbmDigitizeInfo::SetPersistent ( Bool_t  choice = kTRUE)
inline

Set persistence flag.

Parameters
choiceIf kTRUE, the output data (digis) will be persistent.

Definition at line 96 of file CbmDigitizeInfo.h.

References fPersistent.

◆ SetPresent()

void CbmDigitizeInfo::SetPresent ( Bool_t  choice = kTRUE)
inline

Set data presence flag.

Parameters
choicekTRUE if the input data branch is present in the tree

Definition at line 102 of file CbmDigitizeInfo.h.

References fPresent.

◆ ToString()

std::string CbmDigitizeInfo::ToString ( ) const

Info to string.

Definition at line 12 of file CbmDigitizeInfo.cxx.

References fActive, fBranch, fPresent, and fSystem.

Member Data Documentation

◆ fActive

Bool_t CbmDigitizeInfo::fActive
private

Definition at line 114 of file CbmDigitizeInfo.h.

Referenced by IsActive(), SetActive(), and ToString().

◆ fBranch

TString CbmDigitizeInfo::fBranch
private

Definition at line 111 of file CbmDigitizeInfo.h.

Referenced by GetBranchName(), SetBranchName(), and ToString().

◆ fDigitizer

CbmDigitizeBase* CbmDigitizeInfo::fDigitizer
private

Definition at line 112 of file CbmDigitizeInfo.h.

Referenced by GetDigitizer(), and SetDigitizer().

◆ fPersistent

Bool_t CbmDigitizeInfo::fPersistent
private

Definition at line 115 of file CbmDigitizeInfo.h.

Referenced by SetPersistent().

◆ fPresent

Bool_t CbmDigitizeInfo::fPresent
private

Definition at line 113 of file CbmDigitizeInfo.h.

Referenced by IsPresent(), SetPresent(), and ToString().

◆ fSystem

ECbmModuleId CbmDigitizeInfo::fSystem
private

Definition at line 110 of file CbmDigitizeInfo.h.

Referenced by ToString().


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