CbmRoot
CbmDigiBranchBase Class Referenceabstract

Abstract base class for CBM digi branches. More...

#include <CbmDigiBranchBase.h>

Inheritance diagram for CbmDigiBranchBase:
[legend]

Public Member Functions

 CbmDigiBranchBase (const char *name="unknown")
 Constructor. More...
 
virtual ~CbmDigiBranchBase ()
 Destructor. More...
 
virtual Bool_t ConnectToTree ()=0
 Connect the branch to the ROOT tree. More...
 
virtual boost::any GetDigi (UInt_t index)=0
 Get a digi from the branch. More...
 
virtual const CbmMatchGetDigiMatch (UInt_t index)=0
 Get a digi from the branch. More...
 
virtual Bool_t HasMatches ()=0
 Presence of match branch. More...
 
TString GetName () const
 Name of branch. More...
 
virtual std::size_t GetNofDigis () const =0
 Get the number of digis in the branch. More...
 
virtual std::string ToString () const
 String output. More...
 

Protected Attributes

TString fName
 Branch name. More...
 

Detailed Description

Abstract base class for CBM digi branches.

Author
V. Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e
Since
4 June 2019

Abstract interface to branches holding digi objects.

Definition at line 25 of file CbmDigiBranchBase.h.

Constructor & Destructor Documentation

◆ CbmDigiBranchBase()

CbmDigiBranchBase::CbmDigiBranchBase ( const char *  name = "unknown")
inline

Constructor.

Parameters
systemSystem identifier (ECbmModuleId)
nameBranch name

Definition at line 32 of file CbmDigiBranchBase.h.

◆ ~CbmDigiBranchBase()

virtual CbmDigiBranchBase::~CbmDigiBranchBase ( )
inlinevirtual

Destructor.

Definition at line 36 of file CbmDigiBranchBase.h.

Member Function Documentation

◆ ConnectToTree()

virtual Bool_t CbmDigiBranchBase::ConnectToTree ( )
pure virtual

Connect the branch to the ROOT tree.

Parameters
ioManPointer to FairRootManager singleton instance
Returns
kTRUE if branch was found

Implemented in CbmDigiBranch< Digi >.

Referenced by CbmDigiManager::SetBranch().

◆ GetDigi()

virtual boost::any CbmDigiBranchBase::GetDigi ( UInt_t  index)
pure virtual

Get a digi from the branch.

Parameters
indexIndex of digi in branch
Returns
Pointer to constant digi object

Implemented in CbmDigiBranch< Digi >.

◆ GetDigiMatch()

virtual const CbmMatch* CbmDigiBranchBase::GetDigiMatch ( UInt_t  index)
pure virtual

Get a digi from the branch.

Parameters
indexIndex of digi in branch
Returns
Pointer to constant digi object

Implemented in CbmDigiBranch< Digi >.

◆ GetName()

TString CbmDigiBranchBase::GetName ( ) const
inline

Name of branch.

Definition at line 67 of file CbmDigiBranchBase.h.

References fName.

◆ GetNofDigis()

virtual std::size_t CbmDigiBranchBase::GetNofDigis ( ) const
pure virtual

Get the number of digis in the branch.

Implemented in CbmDigiBranch< Digi >.

◆ HasMatches()

virtual Bool_t CbmDigiBranchBase::HasMatches ( )
pure virtual

Presence of match branch.

Returns
kTRUE if a match branch is connected

Implemented in CbmDigiBranch< Digi >.

◆ ToString()

virtual std::string CbmDigiBranchBase::ToString ( ) const
inlinevirtual

String output.

Reimplemented in CbmDigiBranch< Digi >.

Definition at line 75 of file CbmDigiBranchBase.h.

Member Data Documentation

◆ fName

TString CbmDigiBranchBase::fName
protected

Branch name.

Definition at line 79 of file CbmDigiBranchBase.h.

Referenced by CbmDigiBranch< Digi >::ConnectToTree(), GetName(), and CbmDigiBranch< Digi >::ToString().


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