CTPPSDetId Class Reference

Base class for CTPPS detector IDs. More...

#include <CTPPSDetId.h>

Inheritance diagram for CTPPSDetId:

Public Types
enum	NameFlag { nShort, nFull, nPath }
	type of name returned by *Name functions More...
enum	SubDetector { sdTrackingStrip = 3, sdTrackingPixel = 4, sdTimingDiamond = 5, sdTimingFastSilicon = 6 }
	CTPPS sub-detectors. More...
Public Types inherited from DetId
enum	Detector {   Tracker =1, Muon =2, Ecal =3, Hcal =4,   Calo =5, Forward =6, VeryForward =7 }

Public Member Functions
uint32_t	arm () const
void	armName (std::string &name, NameFlag flag=nFull) const
	CTPPSDetId (uint32_t id)
	Construct from a raw id. More...
	CTPPSDetId (uint32_t SubDet, uint32_t Arm, uint32_t Station, uint32_t RomanPot=0)
	Construct from hierarchy indeces. More...
CTPPSDetId	getArmId () const
CTPPSDetId	getRPId () const
CTPPSDetId	getStationId () const
uint32_t	rp () const
void	rpName (std::string &name, NameFlag flag=nFull) const
void	setArm (uint32_t arm)
void	setRP (uint32_t rp)
void	setStation (uint32_t station)
uint32_t	station () const
void	stationName (std::string &name, NameFlag flag=nFull) const
void	subDetectorName (std::string &name, NameFlag flag=nFull) const
Public Member Functions inherited from DetId
Detector	det () const
	get the detector field from this detid More...
	DetId ()
	Create an empty or null id (also for persistence) More...
	DetId (uint32_t id)
	Create an id from a raw number. More...
	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
bool	null () const
	is this a null id ? More...
	operator uint32_t () const
bool	operator!= (DetId id) const
	inequality More...
uint32_t	operator() () const
bool	operator< (DetId id) const
	comparison More...
bool	operator== (DetId id) const
	equality More...
uint32_t	rawId () const
	get the raw id More...
int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Attributes
static const uint32_t	lowMaskArm = 0xFFFFFF
static const uint32_t	lowMaskRP = 0x7FFFF
static const uint32_t	lowMaskStation = 0x3FFFFF
static const uint32_t	maskArm = 0x1
static const uint32_t	maskRP = 0x7
static const uint32_t	maskStation = 0x3
static const uint32_t	maxArm = 1
static const uint32_t	maxRP = 6
static const uint32_t	maxStation = 2
static const uint32_t	startArmBit = 24
static const uint32_t	startRPBit = 19
static const uint32_t	startStationBit = 22
Static Public Attributes inherited from DetId
static const int	kDetOffset = 28
static const int	kSubdetOffset = 25

Static Private Attributes
static const std::string	armNames [] = { "45", "56" }
static const std::string	rpNames [] = { "nr_tp", "nr_bt", "nr_hr", "fr_hr", "fr_tp", "fr_bt", "cyl_hr" }
static const std::string	stationNames [] = { "210", "220cyl", "220" }
static const std::string	subDetectorNames [] = { "", "", "", "ctpps_tr_strip", "ctpps_tr_pixel", "ctpps_ti_diamond", "ctpps_ti_fastsilicon" }
static const std::string	subDetectorPaths [] = { "", "", "", "CTPPS/TrackingStrip", "CTPPS/TrackingPixel", "CTPPS/TimingDiamond", "CTPPS/TimingFastSilicon" }

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Base class for CTPPS detector IDs.

The bit structure is as follows: bits [24:24] => arm: 0 (sector 45), 1 (sector 56) bits [22:23] => station: 0 (210m), 1 (cylyndrical pots), 2 (220m) bits [19:21] => Roman Pot: 0 (near top), 1 (near bottom), 2 (near horizontal), 3 (far horizontal), 4 (far top), 5 (far bottom) bits [0:18] => available for derived classes

The ...Name() methods implement the official naming scheme based on EDMS 906715.

Definition at line 32 of file CTPPSDetId.h.

Member Enumeration Documentation

enum CTPPSDetId::NameFlag

type of name returned by *Name functions

Enumerator
nShort
nFull
nPath

Definition at line 105 of file CTPPSDetId.h.

{ nShort, nFull, nPath };

enum CTPPSDetId::SubDetector

CTPPS sub-detectors.

Enumerator
sdTrackingStrip
sdTrackingPixel
sdTimingDiamond
sdTimingFastSilicon

Definition at line 36 of file CTPPSDetId.h.

{ sdTrackingStrip = 3, sdTrackingPixel = 4, sdTimingDiamond = 5, sdTimingFastSilicon = 6 };

Constructor & Destructor Documentation

CTPPSDetId::CTPPSDetId ( uint32_t  id )

explicit

Construct from a raw id.

Definition at line 31 of file CTPPSDetId.cc.

References DetId::det(), Exception, DetId::subdetId(), and DetId::VeryForward.

Referenced by getArmId(), getRPId(), and getStationId().

                                  : DetId(id)
{
  bool inputOK = (det() == DetId::VeryForward);

  if (!inputOK)
  {
    throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor:"
      << " det: " << det()
      << " subdet: " << subdetId()
      << " is not a valid CTPPS id.";  
  }
}

CTPPSDetId::CTPPSDetId	(	uint32_t	SubDet,
		uint32_t	Arm,
		uint32_t	Station,
		uint32_t	RomanPot = 0
	)

Construct from hierarchy indeces.

Definition at line 46 of file CTPPSDetId.cc.

References Exception, DetId::id_, maskArm, maskRP, maskStation, maxArm, maxRP, maxStation, convertSQLiteXML::ok, sdTimingDiamond, sdTimingFastSilicon, sdTrackingPixel, sdTrackingStrip, startArmBit, startRPBit, and startStationBit.

                                                                                         :       
  DetId(DetId::VeryForward, SubDet)
{
  if (SubDet != sdTrackingStrip && SubDet != sdTrackingPixel && SubDet != sdTimingDiamond && SubDet != sdTimingFastSilicon)
  {
    throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor: invalid sub-detector " << SubDet << ".";
  }

  if (Arm > maxArm || Station > maxStation || RomanPot > maxRP)
  {
    throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor:" 
           << " Invalid parameters:" 
           << " arm=" << Arm
           << " station=" << Station
           << " rp=" << RomanPot
           << std::endl;
  }

  uint32_t ok=0xfe000000;
  id_ &= ok;

  id_ |= ((Arm & maskArm) << startArmBit);
  id_ |= ((Station & maskStation) << startStationBit);
  id_ |= ((RomanPot & maskRP) << startRPBit);
}

Member Function Documentation

uint32_t CTPPSDetId::arm ( ) const

inline

Definition at line 52 of file CTPPSDetId.h.

References DetId::id_, maskArm, and startArmBit.

Referenced by armName(), and TotemRPDetId::getRPDecimalId().

    {
      return ((id_>>startArmBit) & maskArm);
    }

void CTPPSDetId::armName ( std::string &  name, NameFlag  flag = nFull  ) const

inline

Definition at line 115 of file CTPPSDetId.h.

References arm(), armNames, nFull, nPath, nShort, and subDetectorName().

Referenced by stationName().

    {
      switch (flag)
      {
        case nShort: name = ""; break;
        case nFull: subDetectorName(name, flag); name += "_"; break;
        case nPath: subDetectorName(name, flag); name += "/sector "; break;
      }

      name += armNames[arm()];
    }

CTPPSDetId CTPPSDetId::getArmId ( ) const

inline

Definition at line 87 of file CTPPSDetId.h.

References CTPPSDetId(), lowMaskArm, and DetId::rawId().

    {
      return CTPPSDetId( rawId() & (~lowMaskArm) );
    }

CTPPSDetId CTPPSDetId::getRPId ( ) const

inline

Definition at line 97 of file CTPPSDetId.h.

References CTPPSDetId(), lowMaskRP, and DetId::rawId().

    {
      return CTPPSDetId( rawId() & (~lowMaskRP) );
    }

CTPPSDetId CTPPSDetId::getStationId ( ) const

inline

Definition at line 92 of file CTPPSDetId.h.

References CTPPSDetId(), lowMaskStation, and DetId::rawId().

    {
      return CTPPSDetId( rawId() & (~lowMaskStation) );
    }

uint32_t CTPPSDetId::rp ( ) const

inline

Definition at line 74 of file CTPPSDetId.h.

References DetId::id_, maskRP, and startRPBit.

Referenced by TotemRPDetId::getRPDecimalId(), and rpName().

    {
      return ((id_>>startRPBit) & maskRP);
    }

void CTPPSDetId::rpName ( std::string &  name, NameFlag  flag = nFull  ) const

inline

Definition at line 139 of file CTPPSDetId.h.

References nFull, nPath, nShort, rp(), rpNames, and stationName().

Referenced by CTPPSDiamondDetId::planeName(), and TotemRPDetId::planeName().

    {
      switch (flag)
      {
        case nShort: name = ""; break;
        case nFull: stationName(name, flag); name += "_"; break;
        case nPath: stationName(name, flag); name += "/"; break;
      }

      name += rpNames[rp()];
    }

void CTPPSDetId::setArm ( uint32_t  arm )

inline

Definition at line 57 of file CTPPSDetId.h.

References DetId::id_, maskArm, and startArmBit.

    {
      id_ &= ~(maskArm << startArmBit);
      id_ |= ((arm & maskArm) << startArmBit);
    }

void CTPPSDetId::setRP ( uint32_t  rp )

inline

Definition at line 79 of file CTPPSDetId.h.

References DetId::id_, maskRP, and startRPBit.

    {
      id_ &= ~(maskRP << startRPBit);
      id_ |= ((rp & maskRP) << startRPBit);
    }

void CTPPSDetId::setStation ( uint32_t  station )

inline

Definition at line 68 of file CTPPSDetId.h.

References DetId::id_, maskStation, and startStationBit.

    {
      id_ &= ~(maskStation << startStationBit);
      id_ |= ((station & maskStation) << startStationBit);
    }

uint32_t CTPPSDetId::station ( ) const

inline

Definition at line 63 of file CTPPSDetId.h.

References DetId::id_, maskStation, and startStationBit.

Referenced by TotemRPDetId::getRPDecimalId(), and stationName().

    {
      return ((id_>>startStationBit) & maskStation);
    }

void CTPPSDetId::stationName ( std::string &  name, NameFlag  flag = nFull  ) const

inline

Definition at line 127 of file CTPPSDetId.h.

References armName(), nFull, nPath, nShort, station(), and stationNames.

Referenced by rpName().

    {
      switch (flag)
      {
        case nShort: name = ""; break;
        case nFull: armName(name, flag); name += "_"; break;
        case nPath: armName(name, flag); name += "/station "; break;
      }

      name += stationNames[station()];
    }

void CTPPSDetId::subDetectorName ( std::string &  name, NameFlag  flag = nFull  ) const

inline

Definition at line 107 of file CTPPSDetId.h.

References nPath, subDetectorNames, subDetectorPaths, and DetId::subdetId().

Referenced by armName().

    {
      if (flag == nPath)
        name = subDetectorPaths[subdetId()];
      else
        name = subDetectorNames[subdetId()];
    }

Member Data Documentation

const string CTPPSDetId::armNames = { "45", "56" }

staticprivate

Definition at line 154 of file CTPPSDetId.h.

Referenced by armName().

const uint32_t CTPPSDetId::lowMaskArm = 0xFFFFFF

static

Definition at line 46 of file CTPPSDetId.h.

Referenced by getArmId().

const uint32_t CTPPSDetId::lowMaskRP = 0x7FFFF

static

Definition at line 48 of file CTPPSDetId.h.

Referenced by getRPId().

const uint32_t CTPPSDetId::lowMaskStation = 0x3FFFFF

static

Definition at line 47 of file CTPPSDetId.h.

Referenced by getStationId().

const uint32_t CTPPSDetId::maskArm = 0x1

static

Definition at line 46 of file CTPPSDetId.h.

Referenced by arm(), CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), setArm(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::maskRP = 0x7

static

Definition at line 48 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), rp(), setRP(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::maskStation = 0x3

static

Definition at line 47 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), setStation(), station(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::maxArm = 1

static

Definition at line 46 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::maxRP = 6

static

Definition at line 48 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::maxStation = 2

static

Definition at line 47 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), and TotemRPDetId::TotemRPDetId().

const string CTPPSDetId::rpNames = { "nr_tp", "nr_bt", "nr_hr", "fr_hr", "fr_tp", "fr_bt", "cyl_hr" }

staticprivate

Definition at line 156 of file CTPPSDetId.h.

Referenced by rpName().

const uint32_t CTPPSDetId::startArmBit = 24

static

Definition at line 46 of file CTPPSDetId.h.

Referenced by arm(), CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), setArm(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::startRPBit = 19

static

Definition at line 48 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), rp(), setRP(), and TotemRPDetId::TotemRPDetId().

const uint32_t CTPPSDetId::startStationBit = 22

static

Definition at line 47 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), setStation(), station(), and TotemRPDetId::TotemRPDetId().

const string CTPPSDetId::stationNames = { "210", "220cyl", "220" }

staticprivate

Definition at line 155 of file CTPPSDetId.h.

Referenced by stationName().

const string CTPPSDetId::subDetectorNames = { "", "", "", "ctpps_tr_strip", "ctpps_tr_pixel", "ctpps_ti_diamond", "ctpps_ti_fastsilicon" }

staticprivate

Definition at line 152 of file CTPPSDetId.h.

Referenced by subDetectorName().

const string CTPPSDetId::subDetectorPaths = { "", "", "", "CTPPS/TrackingStrip", "CTPPS/TrackingPixel", "CTPPS/TimingDiamond", "CTPPS/TimingFastSilicon" }

staticprivate

Definition at line 153 of file CTPPSDetId.h.

Referenced by subDetectorName().