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

#include <CbmStsModule.h>

Inheritance diagram for CbmStsModule:

Collaboration diagram for CbmStsModule:

Public Member Functions
	CbmStsModule (UInt_t address=0, TGeoPhysicalNode node=nullptr, CbmStsElement mother=nullptr)
	Standard constructor.

virtual	~CbmStsModule ()
	Destructor.

const CbmStsParModule *	GetParameters () const
	Module parameters.

void	SetParameters (const CbmStsParModule &par)
	Set module parameters.

std::string	ToString () const

Int_t	GetAddress () const

CbmStsElement *	GetDaughter (Int_t index) const

Int_t	GetIndex () const

EStsElementLevel	GetLevel () const

CbmStsElement *	GetMother () 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)

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.

EStsElementLevel	fLevel
	Level in hierarchy.

TGeoPhysicalNode *	fNode
	Pointer to geometry.

std::vector< CbmStsElement * >	fDaughters
	Array of daughters.

CbmStsElement *	fMother
	Mother element.

Private Member Functions
virtual void	InitDaughters ()
	Initialise daughters from geometry.

	ClassDef (CbmStsModule, 3)
	Module parameters.

Private Attributes
const CbmStsParModule *	fParams = 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 35 of file CbmStsModule.h.

Constructor & Destructor Documentation

◆ CbmStsModule()

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

Standard constructor.

Parameters

address	Unique element address
node	Geometry node
mother	Mother element

Definition at line 30 of file CbmStsModule.cxx.

References CbmStsElement::CbmStsElement(), and kStsModule.

Referenced by ClassDef().

◆ ~CbmStsModule()

CbmStsModule::~CbmStsModule ( )

virtual

Destructor.

Definition at line 38 of file CbmStsModule.cxx.

Member Function Documentation

◆ ClassDef()

CbmStsModule::ClassDef	(	CbmStsModule	,
		3	)

private

Module parameters.

References CbmStsModule().

◆ ConstructName() [1/2]

void CbmStsElement::ConstructName ( )

protectedinherited

Construct the name of the element

Definition at line 58 of file CbmStsElement.cxx.

References fAddress, fMother, CbmStsAddress::GetElementId(), GetLevel(), kStsHalfLadder, kStsLadder, kStsModule, kStsSensor, kStsSystem, and kStsUnit.

Referenced by CbmStsElement(), and CbmStsSensor::SetAddress().

◆ ConstructName() [2/2]

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

staticinherited

Construct the element name from the address (static)

Parameters

address	Unique element address
level	Element level (unit, ladder, etc.)

Definition at line 95 of file CbmStsElement.cxx.

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

◆ GetAddress()

Int_t CbmStsElement::GetAddress ( ) const

inlineinherited

Get unique address

Returns: Element address

Definition at line 65 of file CbmStsElement.h.

References fAddress.

Referenced by CbmRecoSts::CreateModules(), CbmTaskStsHitFinderParWrite::CreateModules(), CbmStsSetup::Init(), CbmStsMC::Initialize(), CbmStsDigitize::InitModules(), CbmStsDigitize::InitParams(), CbmStsDigitizePixel::InitParams(), CbmStsDigitize::InitSensors(), and CbmStsAnaBase::LoadSetup().

◆ GetAddressFromName()

Int_t CbmStsModule::GetAddressFromName ( TString name )

static

Get the address from the module name (static)

Parameters

name	Name of module @value Unique element address

Definition at line 43 of file CbmStsModule.cxx.

References CbmStsAddress::GetAddress().

◆ GetDaughter()

CbmStsElement * CbmStsElement::GetDaughter ( Int_t index ) const

inherited

Get a daughter element

Parameters

index Index of daughter element

Definition at line 126 of file CbmStsElement.cxx.

References CbmStsElement(), fDaughters, and GetNofDaughters().

Referenced by CbmStsStation::CheckSensorProperties(), CbmRecoSts::CreateModules(), CbmTaskStsHitFinderParWrite::CreateModules(), CbmStsSetup::CreateStations(), CbmStsDigitizeQa::Finish(), CbmStsSetup::GetElement(), GetNofElements(), CbmStsDigitizeQa::Init(), CbmStsSetup::Init(), CbmStsMC::Initialize(), CbmStsAnaBase::LoadSetup(), Print(), and CbmStsDigitizeQa::ProcessAngles().

◆ 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 fAddress, fLevel, and CbmStsAddress::GetElementId().

Referenced by cbm::sts::RecoSetupUnitFactory::CreateStationIdMap(), and CbmStsSetup::CreateStations().

◆ GetLevel()

EStsElementLevel CbmStsElement::GetLevel ( ) const

inlineinherited

Get the element level

Returns: Element level (type enum EStsElementLevel)

Definition at line 83 of file CbmStsElement.h.

References fLevel.

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

◆ GetMother()

CbmStsElement * CbmStsElement::GetMother ( ) const

inlineinherited

Get the mother element

Definition at line 87 of file CbmStsElement.h.

References CbmStsElement(), and fMother.

Referenced by cbm::sts::RecoSetupUnitFactory::CreateStationIdMap(), and CbmStsDigitize::InitSensors().

◆ GetNofDaughters()

Int_t CbmStsElement::GetNofDaughters ( ) const

inlineinherited

Get number of daughter elements

Returns: Number of daughters

Definition at line 93 of file CbmStsElement.h.

References fDaughters.

Referenced by CbmStsStation::CheckSensorProperties(), CbmRecoSts::CreateModules(), CbmTaskStsHitFinderParWrite::CreateModules(), CbmStsSetup::CreateStations(), CbmStsDigitizeQa::Finish(), GetDaughter(), GetNofElements(), CbmStsDigitizeQa::Init(), CbmStsSetup::Init(), InitDaughters(), CbmStsModule::InitDaughters(), CbmStsMC::Initialize(), CbmStsAnaBase::LoadSetup(), Print(), and CbmStsDigitizeQa::ProcessAngles().

◆ GetNofElements()

Int_t CbmStsElement::GetNofElements ( Int_t level ) const

inherited

Get number of elements at given level

Parameters

level Element level (see enum EStsElementLevel)

Returns: Number of elements at given level with this element as ancestor

Definition at line 135 of file CbmStsElement.cxx.

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

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

◆ GetParameters()

const CbmStsParModule * CbmStsModule::GetParameters ( ) const

inline

Module parameters.

Returns: Module parameter object

Definition at line 60 of file CbmStsModule.h.

References fParams.

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

◆ GetPnode()

TGeoPhysicalNode * CbmStsElement::GetPnode ( ) const

inlineinherited

Definition at line 104 of file CbmStsElement.h.

References fNode.

Referenced by CbmStsStation::CheckSensorProperties(), CbmRecoSts::CreateModules(), CbmTaskStsHitFinderParWrite::CreateModules(), CbmStsSetup::CreateStations(), CbmStsSetup::GetStationNumber(), CbmStsMC::Initialize(), CbmStsDigitize::InitParams(), CbmStsDigitizePixel::InitParams(), CbmStsDigitize::InitSensors(), and CbmStsAnaBase::LoadSetup().

◆ InitDaughters()

void CbmStsModule::InitDaughters ( )

privatevirtual

Initialise daughters from geometry.

Reimplemented from CbmStsElement.

Definition at line 70 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

Print

Definition at line 200 of file CbmStsElement.cxx.

References fAddress, fNode, GetDaughter(), GetNofDaughters(), and Print().

Referenced by Print().

◆ SetLevel()

void CbmStsElement::SetLevel ( Int_t level )

protectedinherited

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

Parameters

level Element level

Definition at line 213 of file CbmStsElement.cxx.

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

Referenced by CbmStsElement().

◆ SetMother()

void CbmStsElement::SetMother ( CbmStsElement * mother )

inlineinherited

Set the mother element

Parameters

Pointer to mother element

Definition at line 114 of file CbmStsElement.h.

References CbmStsElement(), and fMother.

◆ SetParameters()

void CbmStsModule::SetParameters ( const CbmStsParModule & par )

inline

Set module parameters.

Parameters

par	Module parameter object

Definition at line 66 of file CbmStsModule.h.

References fParams.

◆ ToString()

string CbmStsModule::ToString ( ) const

String output

Definition at line 105 of file CbmStsModule.cxx.

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

Member Data Documentation

◆ fAddress

Int_t CbmStsElement::fAddress

protectedinherited

Unique element address.

Definition at line 122 of file CbmStsElement.h.

Referenced by CbmStsElement(), CbmStsElement(), ConstructName(), GetAddress(), CbmStsSetup::GetElement(), GetIndex(), CbmStsSensor::GetSensorId(), CbmStsSetup::Init(), InitDaughters(), CbmStsModule::InitDaughters(), Print(), CbmStsSensor::SetAddress(), CbmStsModule::ToString(), and CbmStsSensor::ToString().

◆ fDaughters

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

protectedinherited

Array of daughters.

Definition at line 125 of file CbmStsElement.h.

Referenced by CbmStsElement(), CbmStsElement(), GetDaughter(), GetNofDaughters(), InitDaughters(), and CbmStsModule::InitDaughters().

◆ fLevel

EStsElementLevel CbmStsElement::fLevel

protectedinherited

Level in hierarchy.

Definition at line 123 of file CbmStsElement.h.

Referenced by CbmStsElement(), CbmStsElement(), GetIndex(), GetLevel(), GetNofElements(), InitDaughters(), and SetLevel().

◆ fMother

CbmStsElement* CbmStsElement::fMother

protectedinherited

Mother element.

Definition at line 126 of file CbmStsElement.h.

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

◆ fNode

TGeoPhysicalNode* CbmStsElement::fNode

protectedinherited

Pointer to geometry.

Definition at line 124 of file CbmStsElement.h.

Referenced by CbmStsElement(), CbmStsElement(), CbmStsSensor::GetNode(), GetPnode(), InitDaughters(), CbmStsModule::InitDaughters(), Print(), CbmStsSetup::ReadGeometry(), CbmStsSetup::ReadGeometry(), and CbmStsSensor::SetNode().

◆ fParams

const CbmStsParModule* CbmStsModule::fParams = nullptr

private

Definition at line 79 of file CbmStsModule.h.

Referenced by GetParameters(), and SetParameters().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmStsModule()

◆ ~CbmStsModule()

Member Function Documentation

◆ ClassDef()

◆ ConstructName() [1/2]

◆ ConstructName() [2/2]

◆ GetAddress()

◆ GetAddressFromName()

◆ GetDaughter()

◆ GetIndex()

◆ GetLevel()

◆ GetMother()

◆ GetNofDaughters()

◆ GetNofElements()

◆ GetParameters()

◆ GetPnode()

◆ InitDaughters()

◆ Print()

◆ SetLevel()

◆ SetMother()

◆ SetParameters()

◆ ToString()

Member Data Documentation

◆ fAddress

◆ fDaughters

◆ fLevel

◆ fMother

◆ fNode

◆ fParams