SiStripFecKey.h

Go to the documentation of this file.

#ifndef DataFormats_SiStripCommon_SiStripFecKey_H
#define DataFormats_SiStripCommon_SiStripFecKey_H

#include "DataFormats/SiStripCommon/interface/ConstantsForGranularity.h"
#include "DataFormats/SiStripCommon/interface/SiStripKey.h"

class SiStripFecKey : public SiStripKey {
  
 public:
  
  // ---------- Constructors ----------

  SiStripFecKey( const uint16_t& fec_crate, 
         const uint16_t& fec_slot = 0, 
         const uint16_t& fec_ring = 0, 
         const uint16_t& ccu_addr = 0, 
         const uint16_t& ccu_chan = 0,
         const uint16_t& lld_chan = 0,
         const uint16_t& i2c_addr = 0 );
  
  SiStripFecKey( const uint32_t& fec_key );
  
  SiStripFecKey( const std::string& directory_path );

  SiStripFecKey( const SiStripFecKey& );

  SiStripFecKey( const SiStripKey& );

  SiStripFecKey( const SiStripKey&,
         const sistrip::Granularity& );

  SiStripFecKey();
  
  // ---------- Control structure ----------
  
  inline const uint16_t& fecCrate() const;
  
  inline const uint16_t& fecSlot() const;
  
  inline const uint16_t& fecRing() const;
  
  inline const uint16_t& ccuAddr() const;

  inline const uint16_t& ccuChan() const;

  inline const uint16_t& lldChan() const;

  inline const uint16_t& i2cAddr() const;

  // ---------- Hybrid APV/LLD numbering scheme ---------- 
  
  static uint16_t hybridPos( const uint16_t& i2c_addr );
  
  static uint16_t i2cAddr( const uint16_t& hybrid_pos );
  
  static uint16_t lldChan( const uint16_t& i2c_addr );
  
  static bool firstApvOfPair( const uint16_t& i2c_addr );
  
  static uint16_t i2cAddr( const uint16_t& lld_chan,
               const bool& first_apv_of_pair );
  
  // ---------- Utility methods ---------- 
  
  bool isEqual( const SiStripKey& ) const override;
  
  bool isConsistent( const SiStripKey& ) const override;
  
  bool isValid() const override;
  
  bool isValid( const sistrip::Granularity& ) const override;
  
  bool isInvalid() const override;

  bool isInvalid( const sistrip::Granularity& ) const override;

  // ---------- Print methods ----------

  void print( std::stringstream& ss ) const override;

  void terse( std::stringstream& ss ) const override;
  
 private:
  
  // ---------- Private methods ----------
  
  void initFromValue() override;
  void initFromKey() override;
  void initFromPath() override;
  void initGranularity() override;
  
  // ---------- Private member data ----------

  uint16_t fecCrate_;

  uint16_t fecSlot_;

  uint16_t fecRing_;

  uint16_t ccuAddr_;

  uint16_t ccuChan_;

  uint16_t lldChan_;

  uint16_t i2cAddr_;
  
  // Definition of bit field positions for 32-bit key 
  static const uint16_t fecCrateOffset_ = 27;
  static const uint16_t fecSlotOffset_  = 22;
  static const uint16_t fecRingOffset_  = 18;
  static const uint16_t ccuAddrOffset_  = 10;
  static const uint16_t ccuChanOffset_  =  5;
  static const uint16_t lldChanOffset_  =  2;
  static const uint16_t i2cAddrOffset_  =  0;
  
  // Definition of bit field masks for 32-bit key 
  static const uint16_t fecCrateMask_ = 0x07; // (3 bits)
  static const uint16_t fecSlotMask_  = 0x1F; // (5 bits)
  static const uint16_t fecRingMask_  = 0x0F; // (4 bits)
  static const uint16_t ccuAddrMask_  = 0xFF; // (8 bits)
  static const uint16_t ccuChanMask_  = 0x1F; // (5 bits)
  static const uint16_t lldChanMask_  = 0x07; // (3 bits)
  static const uint16_t i2cAddrMask_  = 0x03; // (2 bits)
  
};

// ---------- Inline methods ----------

const uint16_t& SiStripFecKey::fecCrate() const { return fecCrate_; }
const uint16_t& SiStripFecKey::fecSlot() const { return fecSlot_; }
const uint16_t& SiStripFecKey::fecRing() const { return fecRing_; }
const uint16_t& SiStripFecKey::ccuAddr() const { return ccuAddr_; }
const uint16_t& SiStripFecKey::ccuChan() const { return ccuChan_; }
const uint16_t& SiStripFecKey::lldChan() const { return lldChan_; }
const uint16_t& SiStripFecKey::i2cAddr() const { return i2cAddr_; }

/* const uint16_t& SiStripFecKey::fecCrate() const {  */
/*   return ( key()>>fecCrateOffset_ ) & fecCrateMask_ != fecCrateMask_ ? ( key()>>fecCrateOffset_ ) & fecCrateMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::fecSlot() const {  */
/*   return ( key()>>fecSlotOffset_ ) & fecSlotMask_ != fecSlotMask_ ? ( key()>>fecSlotOffset_ ) & fecSlotMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::fecRing() const {  */
/*   return ( key()>>fecRingOffset_ ) & fecRingMask_ != fecRingMask_ ? ( key()>>fecRingOffset_ ) & fecRingMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::ccuAddr() const {  */
/*   return ( key()>>ccuAddrOffset_ ) & ccuAddrMask_ != ccuAddrMask_ ? ( key()>>ccuAddrOffset_ ) & ccuAddrMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::ccuChan() const {  */
/*   return ( key()>>ccuChanOffset_ ) & ccuChanMask_ != ccuChanMask_ ? ( key()>>ccuChanOffset_ ) & ccuChanMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::lldChan() const {  */
/*   return ( key()>>lldChanOffset_ ) & lldChanMask_ != lldChanMask_ ? ( key()>>lldChanOffset_ ) & lldChanMask_ : sistrip::invalid_;  */
/* } */
/* const uint16_t& SiStripFecKey::i2cAddr() const {  */
/*   return ( key()>>i2cAddrOffset_ ) & i2cAddrMask_ != i2cAddrMask_ ? ( key()>>i2cAddrOffset_ ) & i2cAddrMask_ : sistrip::invalid_;  */
/* } */

std::ostream& operator<< ( std::ostream&, const SiStripFecKey& );

inline bool operator< ( const SiStripFecKey& a, const SiStripFecKey& b ) { return ( a.key() < b.key() ); }

class ConsistentWithKey {
 public: 
  explicit ConsistentWithKey( const SiStripFecKey& key );
  bool operator() ( const uint32_t&, const uint32_t& ) const;
 private:
  explicit ConsistentWithKey();
  SiStripFecKey mask_;
};

#endif // DataFormats_SiStripCommon_SiStripFecKey_H