TotemRPDetId.h

Go to the documentation of this file.

/****************************************************************************
 *
 * This is a part of TOTEM offline software.
 * Authors: 
 *  Hubert Niewiadomski
 *  Jan Kašpar (jan.kaspar@gmail.com) 
 *
 ****************************************************************************/

#ifndef DataFormats_CTPPSDetId_TotemRPDetId
#define DataFormats_CTPPSDetId_TotemRPDetId

#include "DataFormats/CTPPSDetId/interface/CTPPSDetId.h"

#include "FWCore/Utilities/interface/Exception.h"

#include <iosfwd>
#include <iostream>
#include <string>

class TotemRPDetId : public CTPPSDetId
{  
  public:
    explicit TotemRPDetId(uint32_t id);

    TotemRPDetId(const CTPPSDetId &id) : CTPPSDetId(id)
    {
    }
  
    TotemRPDetId(uint32_t Arm, uint32_t Station, uint32_t RomanPot=0, uint32_t Plane=0, uint32_t Chip=0);

    static const uint32_t startPlaneBit, maskPlane, maxPlane, lowMaskPlane;
    static const uint32_t startChipBit, maskChip, maxChip, lowMaskChip;
    
    //-------------------- component getters and setters --------------------
     
    uint32_t plane() const
    {
      return ((id_>>startPlaneBit) & maskPlane);
    }

    void setPlane(uint32_t det)
    {
      id_ &= ~(maskPlane << startPlaneBit);
      id_ |= ((det & maskPlane) << startPlaneBit);
    }

    uint32_t chip() const
    {
      return ((id_>>startChipBit) & maskChip);
    }

    void setChip(uint32_t chip)
    {
      id_ &= ~(maskChip << startChipBit);
      id_ |= ((chip & maskChip) << startChipBit);
    }

    //-------------------- id getters for higher-level objects --------------------

    TotemRPDetId getPlaneId() const
    {
      return TotemRPDetId( rawId() & (~lowMaskPlane) );
    }

    //-------------------- strip orientation methods --------------------

    bool isStripsCoordinateUDirection() const
    {
      return plane() % 2;
    }

    bool isStripsCoordinateVDirection() const
    {
      return !isStripsCoordinateUDirection();
    }

    //-------------------- conversions to the obsolete decimal representation --------------------
    // NOTE: only for backward compatibility, do not use otherwise!
    
    inline uint32_t getRPDecimalId() const
    {
      return rp() + station()*10 + arm()*100;
    }

    inline uint32_t getPlaneDecimalId() const
    {
      return plane() + getRPDecimalId()*10;
    }

    //-------------------- name methods --------------------

    inline void planeName(std::string &name, NameFlag flag = nFull) const
    {
      switch (flag)
      {
        case nShort: name = ""; break;
        case nFull: rpName(name, flag); name += "_"; break;
        case nPath: rpName(name, flag); name += "/plane "; break;
      }

      name += planeNames[plane()];
    }

    inline void chipName(std::string &name, NameFlag flag = nFull) const
    {
      switch (flag)
      {
        case nShort: name = ""; break;
        case nFull: planeName(name, flag); name += "_"; break;
        case nPath: planeName(name, flag); name += "/chip "; break;
      }

      name += chipNames[chip()];
    }

  private:
    static const std::string planeNames[];
    static const std::string chipNames[];
};

std::ostream& operator<<(std::ostream& os, const TotemRPDetId& id);

#endif