#include <RpcFlatCableTranslator.h>

Collaboration diagram for Muon::RpcFlatCableTranslator:

Public Types
using	Storage_t = std::array<uint8_t, readStrips>
	Internal storage array.

Public Member Functions
	RpcFlatCableTranslator (const uint8_t cardId)
	Standard constructor taking the card ID as input.
uint8_t	id () const
	Identifier of the card layout.
std::optional< uint8_t >	tdcChannel (uint8_t strip, MsgStream &log) const
	Returns the connected tdc channel connected to a strip.
std::optional< uint8_t >	stripChannel (uint8_t tdcChannel, MsgStream &log) const
	Returns the strip channel connected to a strip.
bool	mapChannels (uint8_t strip, uint8_t tdc, MsgStream &log)
	Connect the strip with a tdc channel.
const Storage_t &	stripMap () const
	Returns underlying strip mapping storage.
const Storage_t &	tdcMap () const
	Returns the underlying tdc mapping storage.
uint8_t	connectedChannels () const
	Number of connected channels.

Static Public Attributes
static constexpr uint8_t	readStrips = 32
	Number of channels covered by one chip.
static constexpr uint8_t	notSet = 250
	Default value indicating that the channel is not set.
static constexpr uint8_t	firstStrip = 1
	Convention of the lowest strip number.
static constexpr uint8_t	firstTdc = 0
	Convention of the lowest tdc number.

Private Attributes
Storage_t	m_stripToTdc {make_array<uint8_t, readStrips>(notSet)}
Storage_t	m_tdcToStrip {make_array<uint8_t, readStrips>(notSet)}
uint8_t	m_id {0}
uint8_t	m_nCh {0}
	Number of channels that are connected to the cable.

Detailed Description

Definition at line 18 of file RpcFlatCableTranslator.h.

Member Typedef Documentation

◆ Storage_t

using Muon::RpcFlatCableTranslator::Storage_t = std::array<uint8_t, readStrips>

Internal storage array.

Definition at line 29 of file RpcFlatCableTranslator.h.

Constructor & Destructor Documentation

◆ RpcFlatCableTranslator()

Muon::RpcFlatCableTranslator::RpcFlatCableTranslator ( const uint8_t cardId )

Standard constructor taking the card ID as input.

Definition at line 29 of file RpcFlatCableTranslator.cxx.

29 :

30 m_id{cardId} {}

Muon::RpcFlatCableTranslator::m_id

uint8_t m_id

Definition RpcFlatCableTranslator.h:59

Member Function Documentation

◆ connectedChannels()

uint8_t Muon::RpcFlatCableTranslator::connectedChannels ( ) const

Number of connected channels.

Definition at line 32 of file RpcFlatCableTranslator.cxx.

32{ return m_nCh; }

Muon::RpcFlatCableTranslator::m_nCh

uint8_t m_nCh

Number of channels that are connected to the cable.

Definition RpcFlatCableTranslator.h:61

◆ id()

uint8_t Muon::RpcFlatCableTranslator::id ( ) const

Identifier of the card layout.

Definition at line 37 of file RpcFlatCableTranslator.cxx.

37{ return m_id; }

◆ mapChannels()

bool Muon::RpcFlatCableTranslator::mapChannels	(	uint8_t	strip,
		uint8_t	tdc,
		MsgStream &	log )

Connect the strip with a tdc channel.

If the channel has been connected before, false is returned.

Parameters

strip	Strip number on the chamber end
tdc	Tdc channel on the chip end
log	Logger used for debugging

Definition at line 69 of file RpcFlatCableTranslator.cxx.

                                                                                       {
        const uint8_t mapStrip = strip - firstStrip;
        const uint8_t mapTdc = tdc - firstTdc;
        if (mapStrip >= readStrips || m_stripToTdc[mapStrip] != notSet){
            log<<MSG::ERROR<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": The strip "<<static_cast<unsigned>(strip)
               <<" is already mapped to "<<static_cast<unsigned>(m_stripToTdc[mapStrip] + firstTdc)<<std::endl<<(*this)<<endmsg;
            return false;
        }
        if (mapTdc >= readStrips || m_tdcToStrip[mapTdc] != notSet){
            log<<MSG::ERROR<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": The strip "<<static_cast<unsigned>(strip)
               <<" is already mapped to "<<static_cast<unsigned>(m_tdcToStrip[mapTdc] + firstStrip)<<std::endl<<(*this)<<endmsg;
            return false;
        }
        m_stripToTdc[mapStrip] = mapTdc;
        m_tdcToStrip[mapTdc] = mapStrip;
        ++m_nCh;
        if (log.level() <= MSG::VERBOSE) {
            log<<MSG::VERBOSE<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": Map strip "<<static_cast<unsigned>(strip)
                <<" to tdc "<<static_cast<unsigned>(tdc)<<endmsg;
        }
        return true;
    }

◆ stripChannel()

std::optional< uint8_t > Muon::RpcFlatCableTranslator::stripChannel	(	uint8_t	tdcChannel,
		MsgStream &	log ) const

Returns the strip channel connected to a strip.

If the tdc is not connected, a nullopt is returned

Parameters

strip	Strip number. It should range from the first strip until the last covered strip
log	Logger used for debugging

Definition at line 53 of file RpcFlatCableTranslator.cxx.

                                                                                                      {
        const uint8_t mapTdc = (tdcChannel - firstTdc);
        if (mapTdc >= readStrips && log.level() <= MSG::WARNING) {
            log<<MSG::WARNING<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": The parsed tdc "
               <<static_cast<unsigned>(tdcChannel)<<" is out of range"<<endmsg;
            return std::nullopt;
        } 
        if (m_tdcToStrip[mapTdc] == notSet) {
            if (log.level() <= MSG::VERBOSE){
                log<<MSG::VERBOSE<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": The parsed tdc "
                   <<static_cast<unsigned>(tdcChannel)<<" is not connected."<<endmsg;
            }
            return std::nullopt;
        }
        return m_tdcToStrip[mapTdc] + firstStrip;
    }

◆ stripMap()

const RpcFlatCableTranslator::Storage_t & Muon::RpcFlatCableTranslator::stripMap ( ) const

Returns underlying strip mapping storage.

Definition at line 34 of file RpcFlatCableTranslator.cxx.

34{ return m_stripToTdc; }

◆ tdcChannel()

std::optional< uint8_t > Muon::RpcFlatCableTranslator::tdcChannel	(	uint8_t	strip,
		MsgStream &	log ) const

Returns the connected tdc channel connected to a strip.

If the strip is not connected to a tdc, a nullopt is returned.

Parameters

strip	Strip number. It should range from the first strip until the last covered strip
log	Logger used for debugging

Definition at line 38 of file RpcFlatCableTranslator.cxx.

                                                                                               {
        const uint8_t mapStrip = (strip - firstStrip) % readStrips;
        if (m_stripToTdc[mapStrip] == notSet) {
            if (log.level() <= MSG::VERBOSE) {
                log<<MSG::VERBOSE<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<": The channel "
                   <<static_cast<unsigned>(strip)<<" is unmapped."<<endmsg;
            }
            return std::nullopt;
        }
        if (log.level() <= MSG::VERBOSE) {
            log<<MSG::VERBOSE<<"RpcFlatCableTranslator::"<<__func__<<"() - "<<__LINE__<<":  Map channel "
               <<static_cast<unsigned>(strip)<<" to tdc "<<static_cast<unsigned>(m_stripToTdc[mapStrip] + firstTdc)<<endmsg;
        }
        return std::make_optional<uint8_t>(m_stripToTdc[mapStrip] + firstTdc);
    }

◆ tdcMap()

const RpcFlatCableTranslator::Storage_t & Muon::RpcFlatCableTranslator::tdcMap ( ) const

Returns the underlying tdc mapping storage.

Definition at line 35 of file RpcFlatCableTranslator.cxx.

35{ return m_tdcToStrip; }

Member Data Documentation

◆ firstStrip

uint8_t Muon::RpcFlatCableTranslator::firstStrip = 1

staticconstexpr

Convention of the lowest strip number.

Definition at line 25 of file RpcFlatCableTranslator.h.

◆ firstTdc

uint8_t Muon::RpcFlatCableTranslator::firstTdc = 0

staticconstexpr

Convention of the lowest tdc number.

Definition at line 27 of file RpcFlatCableTranslator.h.

◆ m_id

uint8_t Muon::RpcFlatCableTranslator::m_id {0}

private

Definition at line 59 of file RpcFlatCableTranslator.h.

59{0};

◆ m_nCh

uint8_t Muon::RpcFlatCableTranslator::m_nCh {0}

private

Number of channels that are connected to the cable.

Definition at line 61 of file RpcFlatCableTranslator.h.

61{0};

◆ m_stripToTdc

Storage_t Muon::RpcFlatCableTranslator::m_stripToTdc {make_array<uint8_t, readStrips>(notSet)}

private

Definition at line 57 of file RpcFlatCableTranslator.h.

57{make_array<uint8_t, readStrips>(notSet)};

make_array

constexpr std::array< T, N > make_array(const T &def_val)

Helper function to initialize in-place arrays with non-zero values.

Definition ArrayHelper.h:10

◆ m_tdcToStrip

Storage_t Muon::RpcFlatCableTranslator::m_tdcToStrip {make_array<uint8_t, readStrips>(notSet)}

private

Definition at line 58 of file RpcFlatCableTranslator.h.

58{make_array<uint8_t, readStrips>(notSet)};

◆ notSet

uint8_t Muon::RpcFlatCableTranslator::notSet = 250

staticconstexpr

Default value indicating that the channel is not set.

Definition at line 23 of file RpcFlatCableTranslator.h.

◆ readStrips

uint8_t Muon::RpcFlatCableTranslator::readStrips = 32

staticconstexpr

Number of channels covered by one chip.

Definition at line 21 of file RpcFlatCableTranslator.h.

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

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Storage_t

Constructor & Destructor Documentation

◆ RpcFlatCableTranslator()

Member Function Documentation

◆ connectedChannels()

◆ id()

◆ mapChannels()

◆ stripChannel()

◆ stripMap()

◆ tdcChannel()

◆ tdcMap()

Member Data Documentation

◆ firstStrip

◆ firstTdc

◆ m_id

◆ m_nCh

◆ m_stripToTdc

◆ m_tdcToStrip

◆ notSet

◆ readStrips