CbmRoot
CbmStsModule Class Reference

Class representing an instance of a readout unit in the CBM-STS. More...

#include <CbmStsModule.h>

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

Public Member Functions

 CbmStsModule (UInt_t address=0, TGeoPhysicalNode *node=nullptr, CbmStsElement *mother=nullptr)
 Standard constructor. More...
 
virtual ~CbmStsModule ()
 Destructor. More...
 
const CbmStsParModuleGetParameters () const
 Module parameters. More...
 
void SetParameters (const CbmStsParModule &par)
 Set module parameters. More...
 
std::string ToString () const
 
Int_t GetAddress () const
 
CbmStsElementGetDaughter (Int_t index) const
 
Int_t GetIndex () const
 
EStsElementLevel GetLevel () const
 
CbmStsElementGetMother () const
 
Int_t GetNofDaughters () const
 
Int_t GetNofElements (Int_t level) const
 
TGeoPhysicalNode * GetPnode () const
 
void SetMother (CbmStsElement *mother)
 
virtual void Print (Option_t *opt="") const
 

Static Public Member Functions

static Int_t GetAddressFromName (TString name)
 Get the address from the module name (static) More...
 
static TString ConstructName (Int_t address, EStsElementLevel level)
 

Protected Member Functions

void ConstructName ()
 
void SetLevel (Int_t level)
 

Protected Attributes

Int_t fAddress
 Unique element address. More...
 
EStsElementLevel fLevel
 Level in hierarchy. More...
 
TGeoPhysicalNode * fNode
 Pointer to geometry. More...
 
std::vector< CbmStsElement * > fDaughters
 Array of daughters. More...
 
CbmStsElementfMother
 Mother element. More...
 

Private Member Functions

virtual void InitDaughters ()
 Initialise daughters from geometry. More...
 
 ClassDef (CbmStsModule, 3)
 Module parameters. More...
 

Private Attributes

const CbmStsParModulefParams = nullptr
 

Detailed Description

Class representing an instance of a readout unit in the CBM-STS.

Author
V.Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e
Version
2.0

The StsModule is the read-out unit in the CBM STS. It consists of one sensor or two or more daisy-chained sensors (CbmStsSensor), the analogue cable and the read-out electronics.

Definition at line 31 of file CbmStsModule.h.

Constructor & Destructor Documentation

◆ CbmStsModule()

CbmStsModule::CbmStsModule ( UInt_t  address = 0,
TGeoPhysicalNode *  node = nullptr,
CbmStsElement mother = nullptr 
)

Standard constructor.

Parameters
addressUnique element address
nodeGeometry node
motherMother element

Definition at line 26 of file CbmStsModule.cxx.

◆ ~CbmStsModule()

CbmStsModule::~CbmStsModule ( )
virtual

Destructor.

Definition at line 34 of file CbmStsModule.cxx.

Member Function Documentation

◆ ClassDef()

CbmStsModule::ClassDef ( CbmStsModule  ,
 
)
private

Module parameters.

◆ ConstructName() [1/2]

void CbmStsElement::ConstructName ( )
protectedinherited

◆ ConstructName() [2/2]

TString CbmStsElement::ConstructName ( Int_t  address,
EStsElementLevel  level 
)
staticinherited

Construct the element name from the address (static)

Parameters
addressUnique element address
levelElement level (unit, ladder, etc.)

Definition at line 90 of file CbmStsElement.cxx.

References CbmStsAddress::GetElementId(), kStsHalfLadder, kStsLadder, kStsModule, kStsSensor, and kStsUnit.

◆ GetAddress()

◆ GetAddressFromName()

Int_t CbmStsModule::GetAddressFromName ( TString  name)
static

Get the address from the module name (static)

Parameters
nameName of module @value Unique element address

Definition at line 39 of file CbmStsModule.cxx.

References CbmStsAddress::GetAddress().

◆ GetDaughter()

◆ GetIndex()

Int_t CbmStsElement::GetIndex ( ) const
inlineinherited

Get the index within the mother element

Returns
Index of element in mother

Definition at line 77 of file CbmStsElement.h.

References CbmStsElement::fAddress, CbmStsElement::fLevel, and CbmStsAddress::GetElementId().

Referenced by CbmStsSetup::CreateStations().

◆ GetLevel()

EStsElementLevel CbmStsElement::GetLevel ( ) const
inlineinherited

Get the element level

Returns
Element level (type enum EStsElementLevel)

Definition at line 85 of file CbmStsElement.h.

References CbmStsElement::fLevel.

Referenced by CbmStsStation::AddLadder(), and CbmStsElement::ConstructName().

◆ GetMother()

CbmStsElement* CbmStsElement::GetMother ( ) const
inlineinherited

Get the mother element

Definition at line 89 of file CbmStsElement.h.

References CbmStsElement::fMother.

Referenced by CbmStsDigitize::InitSensors().

◆ GetNofDaughters()

◆ GetNofElements()

Int_t CbmStsElement::GetNofElements ( Int_t  level) const
inherited

Get number of elements at given level

Parameters
levelElement level (see enum EStsElementLevel)
Returns
Number of elements at given level with this element as ancestor

Definition at line 128 of file CbmStsElement.cxx.

References CbmStsElement::fLevel, CbmStsElement::GetDaughter(), CbmStsElement::GetNofDaughters(), and CbmStsElement::GetNofElements().

Referenced by CbmStsElement::GetNofElements(), and CbmStsSetup::Init().

◆ GetParameters()

const CbmStsParModule* CbmStsModule::GetParameters ( ) const
inline

Module parameters.

Returns
Module parameter object

Definition at line 58 of file CbmStsModule.h.

References fParams.

Referenced by CbmStsDigitizeQa::Finish(), CbmStsDigitizeQa::Init(), and CbmStsDigitizeQa::ProcessDigisAndPoints().

◆ GetPnode()

◆ InitDaughters()

void CbmStsModule::InitDaughters ( )
privatevirtual

Initialise daughters from geometry.

Reimplemented from CbmStsElement.

Definition at line 65 of file CbmStsModule.cxx.

References CbmStsElement::fAddress, CbmStsElement::fDaughters, CbmStsElement::fNode, CbmStsElement::GetNofDaughters(), kStsSensor, and CbmStsAddress::SetElementId().

◆ Print()

void CbmStsElement::Print ( Option_t *  opt = "") const
virtualinherited

◆ SetLevel()

void CbmStsElement::SetLevel ( Int_t  level)
protectedinherited

Set the element level from integer Protection against being out of range.

Parameters
levelElement level

Definition at line 211 of file CbmStsElement.cxx.

References CbmStsElement::fLevel, kStsHalfLadder, kStsLadder, kStsModule, kStsSensor, kStsSystem, and kStsUnit.

Referenced by CbmStsElement::CbmStsElement().

◆ SetMother()

void CbmStsElement::SetMother ( CbmStsElement mother)
inlineinherited

Set the mother element

Parameters
Pointerto mother element

Definition at line 116 of file CbmStsElement.h.

References CbmStsElement::fMother.

◆ SetParameters()

void CbmStsModule::SetParameters ( const CbmStsParModule par)
inline

Set module parameters.

Parameters
parModule parameter object

Definition at line 64 of file CbmStsModule.h.

References fParams.

◆ ToString()

string CbmStsModule::ToString ( ) const

String output

Definition at line 100 of file CbmStsModule.cxx.

References CbmStsElement::fAddress, and CbmStsAddress::ToString().

Referenced by CbmStsRecoModule::ToString().

Member Data Documentation

◆ fAddress

◆ fDaughters

std::vector<CbmStsElement*> CbmStsElement::fDaughters
protectedinherited

◆ fLevel

◆ fMother

CbmStsElement* CbmStsElement::fMother
protectedinherited

Mother element.

Definition at line 128 of file CbmStsElement.h.

Referenced by CbmStsElement::ConstructName(), CbmStsElement::GetMother(), and CbmStsElement::SetMother().

◆ fNode

TGeoPhysicalNode* CbmStsElement::fNode
protectedinherited

◆ fParams

const CbmStsParModule* CbmStsModule::fParams = nullptr
private

Definition at line 77 of file CbmStsModule.h.

Referenced by GetParameters(), and SetParameters().


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