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

#include <BmnFHCalAddress.h>

Public Member Functions
virtual	~BmnFHCalAddress ()

virtual	~BmnFHCalAddress ()

Static Public Member Functions
static uint32_t	GetAddress (uint32_t ModuleType, 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 uint32_t	GetAddress (uint32_t ModuleType, 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.

Detailed Description

BmnFHCal interface class to the unique address.

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() [1/2]

virtual BmnFHCalAddress::~BmnFHCalAddress ( )

inlinevirtual

Definition at line 30 of file BmnFHCalAddress.h.

◆ ~BmnFHCalAddress() [2/2]

virtual BmnFHCalAddress::~BmnFHCalAddress ( )

inlinevirtual

Definition at line 30 of file BmnFHCalAddress.h.

Member Function Documentation

◆ GetAddress() [1/2]

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

inlinestatic

Return address from system ID, Module type, Module ID, Section ID, Scintillator ID (optional).

Parameters

[in]	Module	type.
[in]	Module	id.
[in]	Section	id.
[in]	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 kFHCAL.

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

◆ GetAddress() [2/2]

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

inlinestatic

Return address from system ID, Module type, Module ID, Section ID, Scintillator ID (optional).

Parameters

[in]	Module	type.
[in]	Module	id.
[in]	Section	id.
[in]	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 kFHCAL.

◆ GetInfoString() [1/2]

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

inlinestatic

Return a formatted string with all address components.

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().

◆ GetInfoString() [2/2]

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

inlinestatic

Return a formatted string with all address components.

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().

◆ GetModuleId() [1/2]

static uint32_t BmnFHCalAddress::GetModuleId ( uint32_t address )

inlinestatic

Return Module id from address.

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 89 of file BmnFHCalAddress.h.

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

◆ GetModuleId() [2/2]

static uint32_t BmnFHCalAddress::GetModuleId ( uint32_t address )

inlinestatic

Return Module id from address.

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 89 of file BmnFHCalAddress.h.

◆ GetModuleType() [1/2]

static uint32_t BmnFHCalAddress::GetModuleType ( uint32_t address )

inlinestatic

Return Module id from address.

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 79 of file BmnFHCalAddress.h.

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

◆ GetModuleType() [2/2]

static uint32_t BmnFHCalAddress::GetModuleType ( uint32_t address )

inlinestatic

Return Module id from address.

Parameters

[in] address Unique channel address.

Returns: Module id from address.

Definition at line 79 of file BmnFHCalAddress.h.

◆ GetPhysicalAddress() [1/2]

static uint32_t BmnFHCalAddress::GetPhysicalAddress ( uint32_t address )

inlinestatic

Return Physical address (w/o scintillator id) from address.

Parameters

[in] address Unique channel address.

Returns: Physical address (w/o scintillator id)

Definition at line 119 of file BmnFHCalAddress.h.

Referenced by BmnFHCalGeo::ListNodesImpl().

◆ GetPhysicalAddress() [2/2]

static uint32_t BmnFHCalAddress::GetPhysicalAddress ( uint32_t address )

inlinestatic

Return Physical address (w/o scintillator id) from address.

Parameters

[in] address Unique channel address.

Returns: Physical address (w/o scintillator id)

Definition at line 119 of file BmnFHCalAddress.h.

◆ GetScintillatorId() [1/2]

static uint32_t BmnFHCalAddress::GetScintillatorId ( uint32_t address )

inlinestatic

Return Scintillator id from address.

Parameters

[in] address Unique channel address.

Returns: Scintillator id from address.

Definition at line 109 of file BmnFHCalAddress.h.

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

◆ GetScintillatorId() [2/2]

static uint32_t BmnFHCalAddress::GetScintillatorId ( uint32_t address )

inlinestatic

Return Scintillator id from address.

Parameters

[in] address Unique channel address.

Returns: Scintillator id from address.

Definition at line 109 of file BmnFHCalAddress.h.

◆ GetSectionId() [1/2]

static uint32_t BmnFHCalAddress::GetSectionId ( uint32_t address )

inlinestatic

Return Section id from address.

Parameters

[in] address Unique channel address.

Returns: Section id from address.

Definition at line 99 of file BmnFHCalAddress.h.

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

◆ GetSectionId() [2/2]

static uint32_t BmnFHCalAddress::GetSectionId ( uint32_t address )

inlinestatic

Return Section id from address.

Parameters

[in] address Unique channel address.

Returns: Section id from address.

Definition at line 99 of file BmnFHCalAddress.h.

◆ GetSystemId() [1/2]

static uint32_t BmnFHCalAddress::GetSystemId ( uint32_t address )

inlinestatic

Return System identifier from address.

Parameters

[in] address Unique channel address.

Returns: System identifier from address.

Definition at line 69 of file BmnFHCalAddress.h.

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

◆ GetSystemId() [2/2]

static uint32_t BmnFHCalAddress::GetSystemId ( uint32_t address )

inlinestatic

Return System identifier from address.

Parameters

[in] address Unique channel address.

Returns: System identifier from address.

Definition at line 69 of file BmnFHCalAddress.h.

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

detectors/fhcal/BmnFHCalAddress.h
install/include/BmnFHCalAddress.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~BmnFHCalAddress() [1/2]

◆ ~BmnFHCalAddress() [2/2]

Member Function Documentation

◆ GetAddress() [1/2]

◆ GetAddress() [2/2]

◆ GetInfoString() [1/2]

◆ GetInfoString() [2/2]

◆ GetModuleId() [1/2]

◆ GetModuleId() [2/2]

◆ GetModuleType() [1/2]

◆ GetModuleType() [2/2]

◆ GetPhysicalAddress() [1/2]

◆ GetPhysicalAddress() [2/2]

◆ GetScintillatorId() [1/2]

◆ GetScintillatorId() [2/2]

◆ GetSectionId() [1/2]

◆ GetSectionId() [2/2]

◆ GetSystemId() [1/2]

◆ GetSystemId() [2/2]