LHCbID.h

Go to the documentation of this file.

//   **************************************************************************
//   *                                                                        *
//   *                      ! ! ! A T T E N T I O N ! ! !                     *
//   *                                                                        *
//   *  This file was created automatically by GaudiObjDesc, please do not    *
//   *  delete it or edit it by hand.                                         *
//   *                                                                        *
//   *  If you want to change this file, first change the corresponding       *
//   *  xml-file and rerun the tools from GaudiObjDesc (or run make if you    *
//   *  are using it from inside a Gaudi-package).                            *
//   *                                                                        *
//   **************************************************************************

#ifndef LHCbKernel_LHCbID_H
#define LHCbKernel_LHCbID_H 1

// Include files
#include "Kernel/VeloChannelID.h"
#include "Kernel/ITChannelID.h"
#include "Kernel/OTChannelID.h"
#include "Kernel/RichSmartID.h"
#include "Kernel/CaloCellID.h"
#include <ostream>


// Forward declarations
class LHCbID;


class LHCbID
{
public:

  LHCbID(const VeloChannelID& chanID);

  LHCbID(const ITChannelID& chanID);

  LHCbID(const OTChannelID& chanID);

  LHCbID(const RichSmartID& chanID);

  LHCbID(const CaloCellID& chanID);

  LHCbID() : m_lhcbID(0) {}

  virtual ~LHCbID() {}

  friend std::ostream& operator<< (std::ostream& str,
                                   const LHCbID& obj);

  virtual std::ostream& fillStream(std::ostream& s) const;

  bool operator==(const LHCbID& chanID) const;

  bool isVelo() const;

  VeloChannelID veloID() const;

  bool isST() const;

  ITChannelID stID() const;

  bool isOT() const;

  OTChannelID otID() const;

  bool isRich() const;

  RichSmartID richID() const;

  bool isCalo() const;

  CaloCellID caloID() const;

  unsigned int channelID() const;

  void setSpareBits(unsigned int value);

  unsigned int spareBits() const;

  unsigned int lhcbID() const;

  void setChannelID(unsigned int value);

  unsigned int detectorType() const;

  void setDetectorType(unsigned int value);

protected:

  enum SpecificMask{ veloMask= 0x1FFFFFL,
                     otMask=0x3FFFFFFL };
  enum SpecificBits{ veloBits=21,
                     otBits=26 };

private:

  enum channelIDType{ veloType=1,
                      stType,
                      otType,
                      richType,
                      caloType,
                      muonType };

  enum lhcbIDBits{channelIDBits    = 0,
                  detectorTypeBits = 28};

  enum lhcbIDMasks{channelIDMask    = 0xFFFFFFFL,
                   detectorTypeMask = 0xF0000000L};


  unsigned int m_lhcbID; 

};

// -----------------------------------------------------------------------------
//   end of class
// -----------------------------------------------------------------------------

// Including forward declarations

inline LHCbID::LHCbID(const VeloChannelID& chanID) : m_lhcbID(0) 
{

  setDetectorType( veloType );
  setChannelID( chanID );
          
}

inline LHCbID::LHCbID(const ITChannelID& chanID) : m_lhcbID(0) 
{

  setDetectorType( stType );
  setChannelID( ((chanID.uniqueWafer()-1)>>4) + (chanID.strip()-1) );
          
}

inline LHCbID::LHCbID(const OTChannelID& chanID) : m_lhcbID(0) 
{

  setDetectorType( otType );
  setChannelID( chanID );
        
}

inline LHCbID::LHCbID(const RichSmartID& chanID) : m_lhcbID(0) 
{

  unsigned int richData = chanID.dataBitsOnly();
  if( chanID.pixelDataAreValid() ) richData += 0x8000000;
  setDetectorType( richType );
  setChannelID( richData );
         
}

inline LHCbID::LHCbID(const CaloCellID& chanID) : m_lhcbID(0) 
{

  setDetectorType( caloType );
  setChannelID( chanID.ccid() );
         
}

inline std::ostream& operator<< (std::ostream& str,
                                 const LHCbID& obj)
{
  return obj.fillStream(str);
}

inline std::ostream& LHCbID::fillStream(std::ostream& s) const
{
  s << "{ " << "lhcbID :        " << m_lhcbID << std::endl << " }";
  return s;
}


inline unsigned int LHCbID::lhcbID() const 
{
  return m_lhcbID;
}

inline void LHCbID::setChannelID(unsigned int value)
{
  unsigned int val = (unsigned int)value;
  m_lhcbID &= ~channelIDMask;
  m_lhcbID |= ((((unsigned int)val) << channelIDBits) & channelIDMask);
}

inline unsigned int LHCbID::detectorType() const
{
  return (unsigned int)((m_lhcbID & detectorTypeMask) >> detectorTypeBits);
}

inline void LHCbID::setDetectorType(unsigned int value)
{
  unsigned int val = (unsigned int)value;
  m_lhcbID &= ~detectorTypeMask;
  m_lhcbID |= ((((unsigned int)val) << detectorTypeBits) & detectorTypeMask);
}

inline bool LHCbID::operator==(const LHCbID& chanID) const 
{

  return (this->lhcbID() == chanID.lhcbID());
         
}

inline bool LHCbID::isVelo() const 
{

  return (veloType == detectorType()) ? true : false;
         
}

inline VeloChannelID LHCbID::veloID() const 
{

  return isVelo() ? channelID() : 0x0;
         
}

inline bool LHCbID::isST() const 
{

  return (stType == detectorType()) ? true : false;
         
}

inline ITChannelID LHCbID::stID() const 
{

  return isST() ? ( ((channelID()&0xFFFF000)<<4)+(channelID()&0xFFF) ) : 0xF0000000;
         
}

inline bool LHCbID::isOT() const 
{

  return (otType == detectorType()) ? true : false;
         
}

inline OTChannelID LHCbID::otID() const 
{

  return isOT() ? channelID() : 0xF0000000;
         
}

inline bool LHCbID::isRich() const 
{

  return (richType == detectorType()) ? true : false;
         
}

inline RichSmartID LHCbID::richID() const 
{

  unsigned int rID = 0;
  if( isRich() ) {
    rID = channelID() & 0x7000000;
    if( channelID() && 0x8000000 ) rID += 0x7E000000;
  }
  return rID;
         
}

inline bool LHCbID::isCalo() const 
{

  return (caloType == detectorType()) ? true : false;
         
}

inline CaloCellID LHCbID::caloID() const 
{

  return isCalo() ? channelID() : 0xF0000000;
         
}

inline unsigned int LHCbID::channelID() const 
{

  unsigned mask = channelIDMask;
  unsigned bits  = channelIDBits;
  if (isVelo()) mask = veloMask;
  if (isOT()) mask = otMask;
  unsigned int id = (m_lhcbID & mask) >> bits;
  return id;
        
}

inline void LHCbID::setSpareBits(unsigned int value) 
{

  if ( !( isVelo() || isOT() ) ) return;
  unsigned int mask = channelIDMask;
  unsigned int bits = channelIDBits;
  if (isVelo()) {
    mask &= (~veloMask);
    bits = veloBits;
  } else if (isOT()) {
    mask &= (~otMask);
    bits = otBits;
  }
  m_lhcbID &= ~mask;
  m_lhcbID |= ((((unsigned int)value) << bits) & mask);
        
}

inline unsigned int LHCbID::spareBits() const 
{

  if ( !( isVelo() || isOT() ) ) return 0;
  unsigned int mask = channelIDMask;
  unsigned int bits = channelIDBits;
  if (isVelo()) {
     mask &= (~veloMask);         
     bits = veloBits;
  } else if (isOT()) {
     mask &= (~otMask);   
     bits = otBits;
  }
  unsigned int val = ((m_lhcbID & mask) >> bits);
  return val;
         
}


#endif 

---