SiStripDetKey.h

Go to the documentation of this file.

 
#ifndef DataFormats_SiStripCommon_SiStripDetKey_h
#define DataFormats_SiStripCommon_SiStripDetKey_h
 
#include "DataFormats/SiStripCommon/interface/ConstantsForGranularity.h"
#include "DataFormats/SiStripCommon/interface/SiStripKey.h"
#include "DataFormats/SiStripDetId/interface/SiStripDetId.h"
 
class SiStripDetKey : public SiStripKey {
public:
  // ---------- Constructors ----------
 
  SiStripDetKey(const uint16_t& partition);
 
  SiStripDetKey(const DetId& det_id, const uint16_t& apv_pair_number = 0, const uint16_t& apv_within_pair = 0);
 
  SiStripDetKey(const SiStripDetId& det_id);
 
  SiStripDetKey(const uint32_t& det_key);
 
  SiStripDetKey(const std::string& directory_path);
 
  SiStripDetKey(const SiStripDetKey&);
 
  SiStripDetKey(const SiStripKey&);
 
  SiStripDetKey(const SiStripKey&, const sistrip::Granularity&);
 
  SiStripDetKey();
 
  // ---------- Public interface to member data ----------
 
  inline const uint16_t& partition() const;
 
  inline const uint16_t& apvPairNumber() const;
 
  inline const uint16_t& apvWithinPair() const;
 
  // ---------- Numbering schemes ----------
 
  //@@ nothing yet
  //@@ switch b/w det_id and det_key
  //@@ switch b/w strip, pair, apv, etc...
 
  // ---------- 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 partition_;
 
  uint16_t apvPairNumber_;
 
  uint16_t apvWithinPair_;
 
  // Definition of bit field positions for 32-bit key
  static const uint16_t partitionOffset_ = 29;
 
  // Definition of bit field masks for 32-bit key
  static const uint16_t partitionMask_ = 0x07;  // (3 bits)
};
 
// ---------- inline methods ----------
 
const uint16_t& SiStripDetKey::partition() const { return partition_; }
const uint16_t& SiStripDetKey::apvPairNumber() const { return apvPairNumber_; }
const uint16_t& SiStripDetKey::apvWithinPair() const { return apvWithinPair_; }
 
std::ostream& operator<<(std::ostream&, const SiStripDetKey&);
 
inline bool operator<(const SiStripDetKey& a, const SiStripDetKey& b) { return (a.key() < b.key()); }
 
#endif  // DataFormats_SiStripCommon_SiStripDetKey_h