BmnFHCal interface class to the unique address. More...

#include <BmnFHCalAddress.h>

Public Member Functions
virtual	~BmnFHCalAddress ()

Static Public Member Functions
static uint32_t	GetAddress (uint32_t ModuleTypeModuleType, uint32_t ModuleId, uint32_t SectionId, uint32_t ScintillatorId=0)
	Return address from system ID, Module type, Module ID, Section ID, Scintillator ID (optional).
static std::string	GetInfoString (uint32_t address)
	Return a formatted string with all address components.
static uint32_t	GetSystemId (uint32_t address)
	Return System identifier from address.
static uint32_t	GetModuleType (uint32_t address)
	Return Module id from address.
static uint32_t	GetModuleId (uint32_t address)
	Return Module id from address.
static uint32_t	GetSectionId (uint32_t address)
	Return Section id from address.
static uint32_t	GetScintillatorId (uint32_t address)
	Return Scintillator id from address.
static uint32_t	GetPhysicalAddress (uint32_t address)
	Return Physical address (w/o scintillator id) from address.

Static Private Attributes
static const uint32_t	fgkSystemIdLength = 31
static const uint32_t	fgkModTypeLength = 3
static const uint32_t	fgkModIdxLength = 127
static const uint32_t	fgkSecIdxLength = 15
static const uint32_t	fgkScintIdxLength = 7
static const uint32_t	fgkSystemIdShift = 0
static const uint32_t	fgkModTypeShift = 5
static const uint32_t	fgkModIdxShift = 7
static const uint32_t	fgkSecIdxShift = 14
static const uint32_t	fgkScintIdxShift = 18

Detailed Description

Author: Nikolay Karpushkin karpu.nosp@m.shki.nosp@m.n@inr.nosp@m..ru

Version: 1.0

BmnFHCalAddress is the class for the concrete interfaces to the unique address, which is encoded in a 32-bit field (uint32_t), for the FHCal detector elements.

                                3         2         1         0   Shift  Bits  Values

Current definition: 10987654321098765432109876543210 System id on bits 0- 4 00000000000000000000000000011111 << 0 5 31 ModType on bits 5- 6 00000000000000000000000001100000 << 5 2 3 ModIdx on bits 7-13 00000000000000000011111110000000 << 7 7 127 SecIdx on bits 14-17 00000000000000111100000000000000 <<14 4 15 ScintIdx on bits 18-20 00000000000111000000000000000000 <<18 3 7

Definition at line 27 of file BmnFHCalAddress.h.

Constructor & Destructor Documentation

◆ ~BmnFHCalAddress()

virtual BmnFHCalAddress::~BmnFHCalAddress ( )

inlinevirtual

Definition at line 30 of file BmnFHCalAddress.h.

Member Function Documentation

◆ GetAddress()

uint32_t BmnFHCalAddress::GetAddress	(	uint32_t	ModuleType,
		uint32_t	ModuleId,
		uint32_t	SectionId,
		uint32_t	ScintillatorId = 0 )

inlinestatic

Parameters

[in]	ModuleType	Module type.
[in]	ModuleId	Module id.
[in]	SectionId	Section id.
[in]	ScintillatorId	Scintillator id.

Returns: Address from system ID, Module type, Module ID, Section ID, Scintillator id (optional).

Definition at line 39 of file BmnFHCalAddress.h.

References fgkModIdxLength, fgkModIdxShift, fgkModTypeLength, fgkModTypeShift, fgkScintIdxLength, fgkScintIdxShift, fgkSecIdxLength, fgkSecIdxShift, fgkSystemIdLength, fgkSystemIdShift, and kFHCAL.

Referenced by BmnFHCalGeo::GetAddressFromPath(), light_yield(), and BmnFHCalRaw2Digit::ParseConfig().

Here is the caller graph for this function:

◆ GetInfoString()

std::string BmnFHCalAddress::GetInfoString ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Formatted string with address components

Definition at line 55 of file BmnFHCalAddress.h.

References GetModuleId(), GetModuleType(), GetScintillatorId(), GetSectionId(), and GetSystemId().

Referenced by BmnFHCalDigitizer::Exec(), BmnFHCalPoint::Print(), and BmnFHCal::ProcessHits().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetModuleId()

uint32_t BmnFHCalAddress::GetModuleId ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 89 of file BmnFHCalAddress.h.

References fgkModIdxLength, and fgkModIdxShift.

Referenced by calibrate_wfm(), GetInfoString(), BmnFHCalGeo::GetMaxModuleId(), BmnFHCalDigit::GetModuleId(), BmnFHCalPoint::GetModuleId(), BmnFHCalRaw2Digit::ParseCalibration(), and BmnFHCalReconstructor::ParseGeometry().

Here is the caller graph for this function:

◆ GetModuleType()

uint32_t BmnFHCalAddress::GetModuleType ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 79 of file BmnFHCalAddress.h.

References fgkModTypeLength, and fgkModTypeShift.

Referenced by GetInfoString(), BmnFHCalDigit::GetModuleType(), BmnFHCalPoint::GetModuleType(), and BmnFHCalReconstructor::ParseGeometry().

Here is the caller graph for this function:

◆ GetPhysicalAddress()

uint32_t BmnFHCalAddress::GetPhysicalAddress ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Physical address (w/o scintillator id)

Definition at line 119 of file BmnFHCalAddress.h.

References fgkScintIdxShift.

Referenced by BmnFHCalDigitizer::FillHitMap(), and BmnFHCalGeo::ListNodesImpl().

Here is the caller graph for this function:

◆ GetScintillatorId()

uint32_t BmnFHCalAddress::GetScintillatorId ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Scintillator id from address.

Definition at line 109 of file BmnFHCalAddress.h.

References fgkScintIdxLength, and fgkScintIdxShift.

Referenced by GetInfoString(), BmnFHCalPoint::GetScintillatorId(), and BmnFHCalGeo::ListNodesImpl().

Here is the caller graph for this function:

◆ GetSectionId()

uint32_t BmnFHCalAddress::GetSectionId ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: Section id from address.

Definition at line 99 of file BmnFHCalAddress.h.

References fgkSecIdxLength, and fgkSecIdxShift.

Referenced by GetInfoString(), BmnFHCalDigit::GetSectionId(), BmnFHCalPoint::GetSectionId(), BmnFHCalRaw2Digit::ParseCalibration(), and BmnFHCalReconstructor::ParseGeometry().

Here is the caller graph for this function:

◆ GetSystemId()

uint32_t BmnFHCalAddress::GetSystemId ( uint32_t address )

inlinestatic

Parameters

[in] address Unique channel address.

Returns: System identifier from address.

Definition at line 69 of file BmnFHCalAddress.h.

References fgkSystemIdLength, and fgkSystemIdShift.

Referenced by GetInfoString(), BmnFHCalDigit::GetSystemId(), and BmnFHCalPoint::GetSystemId().

Here is the caller graph for this function:

Member Data Documentation

◆ fgkModIdxLength

const uint32_t BmnFHCalAddress::fgkModIdxLength = 127

staticprivate

Definition at line 125 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetModuleId().

◆ fgkModIdxShift

const uint32_t BmnFHCalAddress::fgkModIdxShift = 7

staticprivate

Definition at line 132 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetModuleId().

◆ fgkModTypeLength

const uint32_t BmnFHCalAddress::fgkModTypeLength = 3

staticprivate

Definition at line 124 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetModuleType().

◆ fgkModTypeShift

const uint32_t BmnFHCalAddress::fgkModTypeShift = 5

staticprivate

Definition at line 131 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetModuleType().

◆ fgkScintIdxLength

const uint32_t BmnFHCalAddress::fgkScintIdxLength = 7

staticprivate

Definition at line 127 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetScintillatorId().

◆ fgkScintIdxShift

const uint32_t BmnFHCalAddress::fgkScintIdxShift = 18

staticprivate

Definition at line 134 of file BmnFHCalAddress.h.

Referenced by GetAddress(), GetPhysicalAddress(), and GetScintillatorId().

◆ fgkSecIdxLength

const uint32_t BmnFHCalAddress::fgkSecIdxLength = 15

staticprivate

Definition at line 126 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetSectionId().

◆ fgkSecIdxShift

const uint32_t BmnFHCalAddress::fgkSecIdxShift = 14

staticprivate

Definition at line 133 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetSectionId().

◆ fgkSystemIdLength

const uint32_t BmnFHCalAddress::fgkSystemIdLength = 31

staticprivate

Definition at line 123 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetSystemId().

◆ fgkSystemIdShift

const uint32_t BmnFHCalAddress::fgkSystemIdShift = 0

staticprivate

Definition at line 130 of file BmnFHCalAddress.h.

Referenced by GetAddress(), and GetSystemId().

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

detectors/fhcal/BmnFHCalAddress.h

Public Member Functions

Static Public Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~BmnFHCalAddress()

Member Function Documentation

◆ GetAddress()

◆ GetInfoString()

◆ GetModuleId()

◆ GetModuleType()

◆ GetPhysicalAddress()

◆ GetScintillatorId()

◆ GetSectionId()

◆ GetSystemId()

Member Data Documentation

◆ fgkModIdxLength

◆ fgkModIdxShift

◆ fgkModTypeLength

◆ fgkModTypeShift

◆ fgkScintIdxLength

◆ fgkScintIdxShift

◆ fgkSecIdxLength

◆ fgkSecIdxShift

◆ fgkSystemIdLength

◆ fgkSystemIdShift