---

SiStripDetKey.h

Go to the documentation of this file.

// Last commit: $Id: SiStripDetKey.h,v 1.7 2008/02/06 14:32:33 bainbrid Exp $

#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;

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

/*
   @class SiStripDetKey
   @author R.Bainbridge

   @brief Utility class that identifies a position within the strip
   tracker geometrical structure, down to the level of an APV25 chip.

   NOTA BENE: *** NOT FINISHED ***
   
   can generate another key that is NOT DetId and packs
   sistrip-specific data in a more condensed way, so that all levels
   can be encoded with "all" and "invalid" values, down to level of
   apv. also, need "conversion tool" that re-generates DetId key from
   this new key. this is only way...!!!  maybe can "safeguard" use of
   this key as a DetId by reserving bits 22-24 as a flag (eg, set all
   high), so that if an attempt to build DetId using SiStripDetId
   class, we can understand if key is real DetId or not... what about
   going to level of apv?... what about levels about module?...
*/
class SiStripDetKey : public SiStripKey {
  
 public:

  // ---------- Constructors ----------

  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();
  
  // ---------- Public interface to member data ----------
  
  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;
  
  bool isConsistent( const SiStripKey& ) const;
  
  bool isValid() const;
  
  bool isValid( const sistrip::Granularity& ) const;
  
  bool isInvalid() const;
  
  bool isInvalid( const sistrip::Granularity& ) const;

  // ---------- Print methods ----------
  
  virtual void print( std::stringstream& ss ) const;
  
  virtual void terse( std::stringstream& ss ) const {;}
  
 private: 

  // ---------- Private methods ----------

  void initFromValue();
  void initFromKey();
  void initFromPath();
  void initGranularity();
  
  // ---------- Private member data ----------

  uint16_t apvPairNumber_; 

  uint16_t apvWithinPair_; 
  
  // Definition of bit field positions for 32-bit key 
  static const uint16_t tempOffset_ = 0;

  // Definition of bit field masks for 32-bit key 
  static const uint16_t tempMask_ = 0x00F; // (4 bits)
  
};

// ---------- inline methods ----------

const uint16_t& SiStripDetKey::apvPairNumber() const { return apvPairNumber_; }
const uint16_t& SiStripDetKey::apvWithinPair() const { return apvWithinPair_; }

#endif // DataFormats_SiStripCommon_SiStripDetKey_h

---