CbmRoot
Loading...
Searching...
No Matches
CbmFsdDigi Class Reference

Data class for FSD digital information. More...

#include <CbmFsdDigi.h>

Public Member Functions

 CbmFsdDigi ()
 Default constructor.
 
 CbmFsdDigi (uint32_t address, double time, double edep)
 Constructor with assignment.
 
 CbmFsdDigi (uint32_t unitId, uint32_t moduleId, uint32_t photodetId, double time, double edep)
 Constructor with detailed assignment.
 
 ~CbmFsdDigi ()
 
uint32_t GetAddress () const
 Address.
 
double GetTime () const
 Time.
 
double GetCharge () const
 Charge.
 
double GetEdep () const
 Energy deposit.
 
double GetModuleID () const
 Module Identifier.
 
double GetUnitID () const
 Unit Identifier.
 
double GetPhotoDetID () const
 PhotoDet Identifier.
 
void SetAddress (uint32_t address)
 
void SetAddress (uint32_t unitId, uint32_t moduleId, uint32_t photodetId)
 
void SetTime (double time)
 
void SetEdep (double edep)
 
std::string ToString () const
 String output.
 

Static Public Member Functions

static const char * GetClassName ()
 Class name (static)
 
static const char * GetBranchName ()
 Get the desired name of the branch for this obj in the cbm output tree (static)
 
static ECbmModuleId GetSystem ()
 System identifier.
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int)
 
 ClassDefNV (CbmFsdDigi, 1)
 

Private Attributes

uint32_t fAddress = 0
 
double fTime = -1.
 Unique channel address.
 
double fEdep = 0.
 Time of measurement [ns].
 

Friends

class boost::serialization::access
 Energy deposition from FPGA [MeV].
 

Detailed Description

Data class for FSD digital information.

Version
1

Unique Address: 32 bits following CbmFsdAddress Time: 64 bits double Energy deposition: 64 bits double

Definition at line 36 of file CbmFsdDigi.h.

Constructor & Destructor Documentation

◆ CbmFsdDigi() [1/3]

CbmFsdDigi::CbmFsdDigi ( )
inline

Default constructor.

Definition at line 41 of file CbmFsdDigi.h.

◆ CbmFsdDigi() [2/3]

CbmFsdDigi::CbmFsdDigi ( uint32_t address,
double time,
double edep )
inline

Constructor with assignment.

Parameters
addressUnique channel address
timeTime [ns]
edepEnergy deposition

Definition at line 49 of file CbmFsdDigi.h.

◆ CbmFsdDigi() [3/3]

CbmFsdDigi::CbmFsdDigi ( uint32_t unitId,
uint32_t moduleId,
uint32_t photodetId,
double time,
double edep )
inline

Constructor with detailed assignment.

Parameters
unitIdUnit Identifier
moduleIdModule Identifier
photodetIdPhotoDetector Identifier
timeTime [ns]
edepEnergy deposition

Definition at line 59 of file CbmFsdDigi.h.

◆ ~CbmFsdDigi()

CbmFsdDigi::~CbmFsdDigi ( )
inline

Destructor

Definition at line 68 of file CbmFsdDigi.h.

Member Function Documentation

◆ ClassDefNV()

CbmFsdDigi::ClassDefNV ( CbmFsdDigi ,
1  )
private

◆ GetAddress()

uint32_t CbmFsdDigi::GetAddress ( ) const
inline

Address.

Returns
Unique channel address (see CbmFsdAddress)

Definition at line 80 of file CbmFsdDigi.h.

References fAddress.

Referenced by GetModuleID(), GetPhotoDetID(), GetUnitID(), CbmMatchRecoToMC::MatchHitsFsd(), and CbmFsdHitProducer::ProcessData().

◆ GetBranchName()

static const char * CbmFsdDigi::GetBranchName ( )
inlinestatic

Get the desired name of the branch for this obj in the cbm output tree (static)

Returns
"FsdDigi"

Definition at line 86 of file CbmFsdDigi.h.

◆ GetCharge()

double CbmFsdDigi::GetCharge ( ) const
inline

Charge.

Returns
Charge (energy deposition)

Alias for GetEdep(), for compatibility with template methods

Definition at line 100 of file CbmFsdDigi.h.

References fEdep.

◆ GetClassName()

static const char * CbmFsdDigi::GetClassName ( )
inlinestatic

Class name (static)

Returns
CbmFsdDigi

Definition at line 74 of file CbmFsdDigi.h.

◆ GetEdep()

double CbmFsdDigi::GetEdep ( ) const
inline

Energy deposit.

Returns
Energy deposit

Definition at line 106 of file CbmFsdDigi.h.

References fEdep.

Referenced by CbmFsdHitProducer::ProcessData().

◆ GetModuleID()

double CbmFsdDigi::GetModuleID ( ) const
inline

Module Identifier.

Returns
Module number

Definition at line 112 of file CbmFsdDigi.h.

References GetAddress(), CbmFsdAddress::GetElementId(), and CbmFsdAddress::Module.

◆ GetPhotoDetID()

double CbmFsdDigi::GetPhotoDetID ( ) const
inline

PhotoDet Identifier.

Returns
PhotoDet number

Definition at line 130 of file CbmFsdDigi.h.

References GetAddress(), CbmFsdAddress::GetElementId(), and CbmFsdAddress::PhotoDet.

◆ GetSystem()

static ECbmModuleId CbmFsdDigi::GetSystem ( )
inlinestatic

System identifier.

Returns
System ID (ECbmModuleId)

Definition at line 138 of file CbmFsdDigi.h.

References kFsd.

◆ GetTime()

double CbmFsdDigi::GetTime ( ) const
inline

Time.

Returns
Time [ns]

Definition at line 92 of file CbmFsdDigi.h.

References fTime.

Referenced by CbmFsdDigitize::Exec(), CbmFsdHitProducer::ProcessData(), and CbmFsdDigitize::ReleaseBuffer().

◆ GetUnitID()

double CbmFsdDigi::GetUnitID ( ) const
inline

Unit Identifier.

Returns
Unit number

Definition at line 121 of file CbmFsdDigi.h.

References GetAddress(), CbmFsdAddress::GetElementId(), and CbmFsdAddress::Unit.

◆ serialize()

template<class Archive >
void CbmFsdDigi::serialize ( Archive & ar,
const unsigned int  )
inlineprivate

Definition at line 162 of file CbmFsdDigi.h.

References fAddress, fEdep, and fTime.

◆ SetAddress() [1/2]

void CbmFsdDigi::SetAddress ( uint32_t address)
inline

Modifiers

Definition at line 142 of file CbmFsdDigi.h.

References fAddress.

◆ SetAddress() [2/2]

void CbmFsdDigi::SetAddress ( uint32_t unitId,
uint32_t moduleId,
uint32_t photodetId )

Definition at line 20 of file CbmFsdDigi.cxx.

References fAddress, and CbmFsdAddress::GetAddress().

◆ SetEdep()

void CbmFsdDigi::SetEdep ( double edep)
inline

Definition at line 145 of file CbmFsdDigi.h.

References fEdep.

◆ SetTime()

void CbmFsdDigi::SetTime ( double time)
inline

Definition at line 144 of file CbmFsdDigi.h.

References fTime.

◆ ToString()

std::string CbmFsdDigi::ToString ( ) const

String output.

Returns
Info

Definition at line 27 of file CbmFsdDigi.cxx.

References fAddress, fEdep, and fTime.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Energy deposition from FPGA [MeV].

BOOST serialization interface

Definition at line 160 of file CbmFsdDigi.h.

Member Data Documentation

◆ fAddress

uint32_t CbmFsdDigi::fAddress = 0
private

Definition at line 155 of file CbmFsdDigi.h.

Referenced by GetAddress(), serialize(), SetAddress(), SetAddress(), and ToString().

◆ fEdep

double CbmFsdDigi::fEdep = 0.
private

Time of measurement [ns].

Definition at line 157 of file CbmFsdDigi.h.

Referenced by GetCharge(), GetEdep(), serialize(), SetEdep(), and ToString().

◆ fTime

double CbmFsdDigi::fTime = -1.
private

Unique channel address.

Definition at line 156 of file CbmFsdDigi.h.

Referenced by GetTime(), serialize(), SetTime(), and ToString().


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