L1CaloCoolChannelId Class Reference

Encapsulates the ID of one channel of conditions data in COOL, ie the ID of a row in a table. More...

#include <L1CaloCoolChannelId.h>

Collaboration diagram for L1CaloCoolChannelId:

Public Member Functions
	L1CaloCoolChannelId ()
	Create a L1CaloCoolChannelId from the integer ID field.
	L1CaloCoolChannelId (unsigned int crate, L1CaloModuleType mType, unsigned int module, unsigned int submodule, unsigned int channel, bool logical=true)
	Create a L1CaloCoolChannelId from its component fields.
	L1CaloCoolChannelId (unsigned int id)
	Create a L1CaloCoolChannelId from the integer ID field.
	L1CaloCoolChannelId (const L1CaloCoolChannelId &id)
	Copy a L1CaloCoolChannelId.
	~L1CaloCoolChannelId ()=default
unsigned int	crate () const
L1CaloModuleType	moduleType () const
	Return module type of this channel ID.
unsigned int	module (bool logical=true) const
	Convert a typeId to a L1CaloModuleType.
unsigned int	subModule () const
unsigned int	channel () const
unsigned int	id () const
L1CaloCoolChannelId &	operator= (const L1CaloCoolChannelId &id)
	Copy a L1CaloCoolChannelId.
bool	operator== (const L1CaloCoolChannelId &id) const
bool	operator< (const L1CaloCoolChannelId &id) const

Private Member Functions
unsigned int	logicalToPhysicalModule (L1CaloModuleType mType, unsigned int module) const
unsigned int	physicalToLogicalModule (L1CaloModuleType mType, unsigned int module) const
void	setId (unsigned int crate, L1CaloModuleType mType, unsigned int module, unsigned int submodule, unsigned int channel)
	Set the CoolChannelId value from its component fields.

Private Attributes
unsigned int	m_id

Friends
std::ostream &	operator<< (std::ostream &output, const L1CaloCoolChannelId &r)

Detailed Description

Encapsulates the ID of one channel of conditions data in COOL, ie the ID of a row in a table.

At present, COOL can only handle integer IDs, so we encode crate, module type, module in crate, submodule, and channel with module or submodule into a 32 bit quantity as follows:

• bits 31-24 crate number (0-7=PP, 8-11=CP, 12-13=JEP, 14-15=ROD)
• bits 23-20 module type (1=PPM, 2=CPM, 3=JEM, 4=CMM, 5=TCM, 6=ROD, 7=CAM)
• bits 19-16 module number in crate
• bits 15-08 submodule number in module (if appropriate)
• bits 08-00 channel number in (sub)module (if appropriate)

This class is a very close adaptation of the online coolL1Calo/L1CaloCoolChannelId class

Definition at line 10 of file L1CaloCoolChannelId.h.

Constructor & Destructor Documentation

L1CaloCoolChannelId() [1/4]

L1CaloCoolChannelId::L1CaloCoolChannelId

(

)

Create a L1CaloCoolChannelId from the integer ID field.

Definition at line 34 of file L1CaloCoolChannelId.cxx.

  : m_id(0)
{
}

L1CaloCoolChannelId() [2/4]

L1CaloCoolChannelId::L1CaloCoolChannelId	(	unsigned int	crate,
		L1CaloModuleType	mType,
		unsigned int	module,
		unsigned int	submodule,
		unsigned int	channel,
		bool	logical = true )

Create a L1CaloCoolChannelId from its component fields.

Definition at line 45 of file L1CaloCoolChannelId.cxx.

  : m_id(0)
{
    if(logical) this->setId(crate, mType, module, submodule, channel);
    else {
        unsigned int moduleIndex = this->physicalToLogicalModule(mType, module);
        this->setId(crate, mType, moduleIndex, submodule, channel);
    }
}

L1CaloCoolChannelId() [3/4]

L1CaloCoolChannelId::L1CaloCoolChannelId

(

unsigned int

id

)

Create a L1CaloCoolChannelId from the integer ID field.

Definition at line 66 of file L1CaloCoolChannelId.cxx.

  : m_id(id)
{
}

L1CaloCoolChannelId() [4/4]

L1CaloCoolChannelId::L1CaloCoolChannelId

(

const L1CaloCoolChannelId &

id

)

Copy a L1CaloCoolChannelId.

Definition at line 77 of file L1CaloCoolChannelId.cxx.

  : m_id(id.m_id)
{
}

~L1CaloCoolChannelId()

L1CaloCoolChannelId::~L1CaloCoolChannelId ( )

default

Member Function Documentation

channel()

unsigned int L1CaloCoolChannelId::channel ( ) const

inline

Definition at line 30 of file L1CaloCoolChannelId.h.

{ return (m_id & 0x000000ff); }

crate()

unsigned int L1CaloCoolChannelId::crate ( ) const

inline

Definition at line 25 of file L1CaloCoolChannelId.h.

{ return (m_id & 0xff000000) >> 24; }

id()

unsigned int L1CaloCoolChannelId::id ( ) const

inline

Definition at line 32 of file L1CaloCoolChannelId.h.

{ return m_id; }

logicalToPhysicalModule()

unsigned int L1CaloCoolChannelId::logicalToPhysicalModule ( L1CaloModuleType mType, unsigned int module ) const

private

Definition at line 171 of file L1CaloCoolChannelId.cxx.

                                                                                                           {
    if      (mType == L1CaloModuleType::Ppm) { return module + 5; } //Ppm
    else if (mType == L1CaloModuleType::Cpm) { return module + 5; } //Cpm
    else if (mType == L1CaloModuleType::Jem) { return module + 4; } //Jem
    else {
        std::cout<<"The physical position of module type: "<<mType.toString()<<" is not known. Returning the logical index instead !"<<std::endl;
        return module;
    }
}

module()

unsigned int L1CaloCoolChannelId::module

(

bool

logical = true

)

const

Convert a typeId to a L1CaloModuleType.

Returns

L1CaloModuleType

Convert a L1CaloModuleType to a typeId

Returns

unsigned int

Definition at line 162 of file L1CaloCoolChannelId.cxx.

                                                           {
    unsigned int logicalIndex = (m_id & 0x000f0000) >> 16;
    if(logical) {
        return logicalIndex;
    } else {
        return this->logicalToPhysicalModule(this->moduleType(), logicalIndex);
    }
}

moduleType()

L1CaloModuleType L1CaloCoolChannelId::moduleType

(

)

const

Return module type of this channel ID.

Returns

L1CaloModuleType

Definition at line 120 of file L1CaloCoolChannelId.cxx.

{
  unsigned int mTypeId = (m_id & 0x00f00000) >> 20;
  return L1CaloModuleType((L1CaloModuleType::L1CaloModuleEnum)mTypeId);
}

operator<()

bool L1CaloCoolChannelId::operator<

(

const L1CaloCoolChannelId &

id

)

const

Definition at line 205 of file L1CaloCoolChannelId.cxx.

                                                                       {
    return m_id<id.m_id;
}

operator=()

L1CaloCoolChannelId & L1CaloCoolChannelId::operator=

(

const L1CaloCoolChannelId &

id

)

Copy a L1CaloCoolChannelId.

Definition at line 199 of file L1CaloCoolChannelId.cxx.

{
  if (this != &id) m_id = id.m_id;
  return *this;
}

operator==()

bool L1CaloCoolChannelId::operator==

(

const L1CaloCoolChannelId &

id

)

const

Definition at line 209 of file L1CaloCoolChannelId.cxx.

                                                                        {
    return m_id==id.m_id;
}

physicalToLogicalModule()

unsigned int L1CaloCoolChannelId::physicalToLogicalModule ( L1CaloModuleType mType, unsigned int module ) const

private

Definition at line 181 of file L1CaloCoolChannelId.cxx.

                                                                                                           {
    if      (mType == L1CaloModuleType::Ppm) { return module - 5; } //Ppm
    else if (mType == L1CaloModuleType::Cpm) { return module - 5; } //Cpm
    else if (mType == L1CaloModuleType::Jem) { return module - 4; } //Jem
    else {
        std::cout<<"The physical position of module type: "<<mType.toString()<<" is not known. Returning the logical index instead !"<<std::endl;
        return module;
    }
}

setId()

void L1CaloCoolChannelId::setId ( unsigned int crate, L1CaloModuleType mType, unsigned int module, unsigned int submodule, unsigned int channel )

private

Set the CoolChannelId value from its component fields.

Definition at line 89 of file L1CaloCoolChannelId.cxx.

{
  m_id = (crate & 0xff)     << 24 | (module & 0x0f) << 16 |
         (submodule & 0xff) <<  8 | (channel & 0xff);
  // We only have a limited number of module types that will
  // provide conditions data, so convert module types here.
  // Ignore any other module type.
 
  m_id |= ((unsigned int)mType & 0x0f) << 20;
 
//  if      (mType == L1CaloModuleType::Ppm)       { m_id |= 0x00100000; }
//  else if (mType == L1CaloModuleType::Cpm)       { m_id |= 0x00200000; }
//  else if (mType == L1CaloModuleType::Jem)       { m_id |= 0x00300000; }
//  else if (mType == L1CaloModuleType::Cmm)       { m_id |= 0x00400000; }
//  else if (mType == L1CaloModuleType::Tcm)       { m_id |= 0x00500000; }
//  else if (mType == L1CaloModuleType::L1CaloRod) { m_id |= 0x00600000; }
//  else if (mType == L1CaloModuleType::Cam)       { m_id |= 0x00700000; }
}

subModule()

unsigned int L1CaloCoolChannelId::subModule ( ) const

inline

Definition at line 29 of file L1CaloCoolChannelId.h.

{ return (m_id & 0x0000ff00) >> 8; }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & output, const L1CaloCoolChannelId & r )

friend

Definition at line 213 of file L1CaloCoolChannelId.cxx.

                                                                          {
    output << "coolChannelId: 0x" << std::hex <<r.id() << std::dec <<"("<<r.id()<<"), crate: "<<r.crate()<<", module: "<<r.module()<<", submodule: "<<r.subModule()<<", channel: "<<r.channel();
    return output;
}

Member Data Documentation

m_id

unsigned int L1CaloCoolChannelId::m_id

private

Definition at line 51 of file L1CaloCoolChannelId.h.

---

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

• L1CaloCoolChannelId.h
• L1CaloCoolChannelId.cxx