SiStripKey.h

Go to the documentation of this file.

#ifndef DataFormats_SiStripCommon_SiStripKey_H
#define DataFormats_SiStripCommon_SiStripKey_H

#include "DataFormats/SiStripCommon/interface/ConstantsForGranularity.h"
#include <boost/cstdint.hpp>
#include <ostream>
#include <sstream>
#include <string>

class SiStripKey;

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

class SiStripKey {
  
 public:
  
  // ---------- Constructors ----------
  
  SiStripKey( const uint32_t& key );
  
  SiStripKey( const std::string& directory_path );
  
  SiStripKey( const SiStripKey& );

  const SiStripKey& operator=( const SiStripKey& );
  
  SiStripKey();

  virtual ~SiStripKey() {;}
  
  // ---------- Public interface to member data ----------
  
  inline const uint32_t& key() const;

  inline const std::string& path() const;

  inline const sistrip::Granularity& granularity() const;

  inline const uint16_t& channel() const;

  // ---------- Virtual utility methods ---------- 
  
  virtual bool isEqual( const SiStripKey& ) const;
  
  virtual bool isConsistent( const SiStripKey& ) const;

  virtual bool isValid() const;
  
  virtual bool isValid( const sistrip::Granularity& ) const;
  
  virtual bool isInvalid() const;

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

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

  virtual void print( std::stringstream& ss ) const;
  
  virtual void terse( std::stringstream& ss ) const {;}
  
 protected: 

  // ---------- Protected methods ----------

  virtual void initFromValue() {;}
  virtual void initFromKey() {;}
  virtual void initFromPath() {;}
  virtual void initGranularity() {;}
  
  inline void key( const uint32_t& );
  inline void path( const std::string& );
  inline void granularity( const sistrip::Granularity& );
  inline void channel( const uint16_t& );

 private: 
  
  // ---------- Private member data ----------
  
  uint32_t key_; 

  std::string path_;

  sistrip::Granularity granularity_;

  uint16_t channel_;
  
};

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

const uint32_t& SiStripKey::key() const { return key_; }
const std::string& SiStripKey::path() const { return path_; }
const sistrip::Granularity& SiStripKey::granularity() const { return granularity_; }
const uint16_t& SiStripKey::channel() const { return channel_; }

void SiStripKey::key( const uint32_t& key ) { key_ = key; }
void SiStripKey::path( const std::string& path ) { path_ = path; }
void SiStripKey::granularity( const sistrip::Granularity& gran ) { granularity_ = gran; }
void SiStripKey::channel( const uint16_t& chan ) { channel_ = chan; }

#endif // DataFormats_SiStripCommon_SiStripKey_H