SiStripFedKey.h

Go to the documentation of this file.

#ifndef DataFormats_SiStripCommon_SiStripFedKey_H
#define DataFormats_SiStripCommon_SiStripFedKey_H

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

class SiStripFedKey;

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

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

  SiStripFedKey(const uint16_t& fed_id,
                const uint16_t& fe_unit = 0,
                const uint16_t& fe_chan = 0,
                const uint16_t& fed_apv = 0);

  SiStripFedKey(const uint32_t& fed_key);

  SiStripFedKey(const std::string& directory_path);

  SiStripFedKey(const SiStripFedKey&);

  SiStripFedKey(const SiStripKey&);

  SiStripFedKey();

  SiStripFedKey& operator=(const SiStripFedKey&) = default;

  // ---------- Public interface to member data ----------

  inline const uint16_t& fedId() const;

  inline const uint16_t& feUnit() const;

  inline const uint16_t& feChan() const;

  inline const uint16_t& fedApv() const;

  inline uint16_t fedChannel() const;

  // ---------- Numbering schemes ----------

  static uint16_t fedCh(const uint16_t& fe_unit, const uint16_t& fe_chan);

  static uint16_t feUnit(const uint16_t& fed_ch);

  static uint16_t feChan(const uint16_t& fed_ch);

  static uint32_t fedIndex(const uint16_t& fed_id, const uint16_t& fed_ch);

  // ---------- 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 fedId_;

  uint16_t feUnit_;

  uint16_t feChan_;

  uint16_t fedApv_;

  // Definition of bit field positions for 32-bit key
  static const uint16_t fedCrateOffset_ = 24;
  static const uint16_t fedSlotOffset_ = 19;
  static const uint16_t fedIdOffset_ = 10;
  static const uint16_t feUnitOffset_ = 6;
  static const uint16_t feChanOffset_ = 2;
  static const uint16_t fedApvOffset_ = 0;

  // Definition of bit field masks for 32-bit key
  static const uint16_t fedCrateMask_ = 0x03F;  // (6 bits)
  static const uint16_t fedSlotMask_ = 0x01F;   // (5 bits)
  static const uint16_t fedIdMask_ = 0x1FF;     // (9 bits)
  static const uint16_t feUnitMask_ = 0x00F;    // (4 bits)
  static const uint16_t feChanMask_ = 0x00F;    // (4 bits)
  static const uint16_t fedApvMask_ = 0x003;    // (2 bits)
};

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

const uint16_t& SiStripFedKey::fedId() const { return fedId_; }
const uint16_t& SiStripFedKey::feUnit() const { return feUnit_; }
const uint16_t& SiStripFedKey::feChan() const { return feChan_; }
const uint16_t& SiStripFedKey::fedApv() const { return fedApv_; }
uint16_t SiStripFedKey::fedChannel() const { return fedCh(feUnit_, feChan_); }

#endif  // DataFormats_SiStripCommon_SiStripFedKey_H