SiStripFedCabling.h

Go to the documentation of this file.

#ifndef CondFormats_SiStripObjects_SiStripFedCabling_H
#define CondFormats_SiStripObjects_SiStripFedCabling_H

#include "CondFormats/SiStripObjects/interface/FedChannelConnection.h"
#include <boost/range/iterator_range.hpp>
#include <boost/cstdint.hpp>
#include <sstream>
#include <vector>
#include <string>

#define SISTRIPCABLING_USING_NEW_STRUCTURE
#define SISTRIPCABLING_USING_NEW_INTERFACE


// -------------------------------------------------------
#ifndef SISTRIPCABLING_USING_NEW_STRUCTURE // ------------
// -------------------------------------------------------


class SiStripFedCabling;

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

class SiStripFedCabling {
  
 public:
  
  // -------------------- Constructors, destructors --------------------

  SiStripFedCabling( const std::vector<FedChannelConnection>& );

  SiStripFedCabling( const SiStripFedCabling& ); 

  SiStripFedCabling();

  ~SiStripFedCabling();

  // -------------------- Utility methods --------------------
  
  void buildFedCabling( const std::vector<FedChannelConnection>& connections );
  
  void print( std::stringstream& ) const;
  
  void terse( std::stringstream& ) const;
  
  void summary( std::stringstream& ) const;

  // -------------------- Methods to retrieve connections --------------------

  const std::vector<uint16_t>& feds() const;
  
  const std::vector<FedChannelConnection>& connections( uint16_t fed_id ) const; 
  
  const FedChannelConnection& connection( uint16_t fed_id,
                      uint16_t fed_chan ) const; 
  
  inline const std::vector<FedChannelConnection>& detected() const; 
  
  inline const std::vector<FedChannelConnection>& undetected() const; 
  
  // -------------------- Private member data --------------------

 private:
  
  std::vector<uint16_t> feds_;

  std::vector< std::vector<FedChannelConnection> > connected_;

  std::vector<FedChannelConnection> detected_;

  std::vector<FedChannelConnection> undetected_;

};

const std::vector<FedChannelConnection>& SiStripFedCabling::detected() const { return detected_; }
const std::vector<FedChannelConnection>& SiStripFedCabling::undetected() const{ return undetected_; }


// -------------------------------------------------------------
#else // SISTRIPCABLING_USING_NEW_STRUCTURE --------------------
#ifndef SISTRIPCABLING_USING_NEW_INTERFACE // ------------------
// -------------------------------------------------------------


class SiStripFedCabling;

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

class SiStripFedCabling {
  
 public:
  
  // -------------------- Typedefs and structs --------------------

  typedef std::vector<uint16_t> Feds;

  typedef Feds::iterator FedsIter;

  typedef Feds::const_iterator FedsConstIter;

  typedef boost::iterator_range<FedsIter> FedsIterRange;

  typedef boost::iterator_range<FedsConstIter> FedsConstIterRange;

  typedef std::vector<FedChannelConnection> Conns;

  typedef Conns::iterator ConnsIter;

  typedef Conns::const_iterator ConnsConstIter;
  
  typedef boost::iterator_range<ConnsIter> ConnsIterRange;

  typedef boost::iterator_range<ConnsConstIter> ConnsConstIterRange;

  typedef std::pair<uint32_t,uint32_t> ConnsPair;
  
  typedef std::vector<ConnsPair> Registry;
  
  // -------------------- Constructors, destructors --------------------

  SiStripFedCabling( const std::vector<FedChannelConnection>& );

  SiStripFedCabling( const SiStripFedCabling& ); 

  SiStripFedCabling();

  ~SiStripFedCabling();

  // -------------------- Methods to retrieve connections --------------------

  const std::vector<uint16_t>& feds() const;
  
  const std::vector<FedChannelConnection>& connections( uint16_t fed_id ) const; 
  
  const FedChannelConnection& connection( uint16_t fed_id,
                      uint16_t fed_chan ) const; 
  
  inline const std::vector<FedChannelConnection>& detected() const; 
  
  inline const std::vector<FedChannelConnection>& undetected() const; 

  // -------------------- Utility methods --------------------
  
  void buildFedCabling( const std::vector<FedChannelConnection>& connections );
  
  void print( std::stringstream& ) const;
  
  void terse( std::stringstream& ) const;
  
  void summary( std::stringstream& ) const;

  class ConnsRange {

  public:
    
    ConnsRange( const Conns&, ConnsPair );
    ConnsRange( const Conns& );
    ConnsRange() {;}
    
    ConnsConstIter begin() const;
    ConnsConstIter end() const;
    ConnsConstIterRange range() const;
    ConnsConstIterRange invalid() const;
    
    bool empty() const;
    uint32_t size() const;

    ConnsPair connsPair() const;
    static ConnsPair emptyPair();

    void print( std::stringstream& ) const;
    
  private:
    
    ConnsConstIterRange vector_;
    ConnsConstIterRange range_;

  };

  ConnsRange range( ConnsPair ) const;
  
  // -------------------- Private member data --------------------

 private:

  Feds feds_;
  
  Registry registry_;
  
  Conns connections_;

  Conns detected_;
  
  Conns undetected_;

};

std::ostream& operator<<( std::ostream&, const SiStripFedCabling::ConnsRange& );

inline const std::vector<FedChannelConnection>& SiStripFedCabling::detected() const { 
  return detected_; 
}

inline const std::vector<FedChannelConnection>& SiStripFedCabling::undetected() const{ 
  return undetected_; 
}

inline SiStripFedCabling::ConnsConstIter SiStripFedCabling::ConnsRange::begin() const { 
  return range_.begin(); 
}

inline SiStripFedCabling::ConnsConstIter SiStripFedCabling::ConnsRange::end() const { 
  return range_.end(); 
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::ConnsRange::range() const { 
  return range_;
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::ConnsRange::invalid() const { 
  return ConnsConstIterRange( vector_.end(), vector_.end() );
}

inline bool SiStripFedCabling::ConnsRange::empty() const { 
  return ( range_.begin() == range_.end() );
}

inline uint32_t SiStripFedCabling::ConnsRange::size() const { 
  return std::distance( range_.begin(), range_.end() );
}

inline SiStripFedCabling::ConnsPair SiStripFedCabling::ConnsRange::connsPair() const { 
  return ( ( range_.begin() == vector_.end() && 
         range_.end()   == vector_.end() ) ?
       ConnsPair( sistrip::invalid32_, sistrip::invalid32_ ) :
       ConnsPair( std::distance( vector_.begin(), range_.begin() ), 
              std::distance( vector_.begin(), range_.end() ) ) );
}

inline SiStripFedCabling::ConnsPair SiStripFedCabling::ConnsRange::emptyPair() { 
  return ConnsPair( sistrip::invalid32_, sistrip::invalid32_ );
}

inline SiStripFedCabling::ConnsRange SiStripFedCabling::range( SiStripFedCabling::ConnsPair p ) const {
  return ConnsRange( connections_, p );
}


// -------------------------------------------------------------
#else // SISTRIPCABLING_USING_NEW_INTERFACE --------------------
// -------------------------------------------------------------


class SiStripFedCabling;

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

class SiStripFedCabling {
  
 public:
  
  // -------------------- Typedefs and structs --------------------

  typedef std::vector<uint16_t> Feds;

  typedef Feds::iterator FedsIter;

  typedef Feds::const_iterator FedsConstIter;

  typedef boost::iterator_range<FedsIter> FedsIterRange;

  typedef boost::iterator_range<FedsConstIter> FedsConstIterRange;

  typedef std::vector<FedChannelConnection> Conns;

  typedef Conns::iterator ConnsIter;

  typedef Conns::const_iterator ConnsConstIter;
  
  typedef boost::iterator_range<ConnsIter> ConnsIterRange;

  typedef boost::iterator_range<ConnsConstIter> ConnsConstIterRange;

  typedef std::pair<uint32_t,uint32_t> ConnsPair;
  
  typedef std::vector<ConnsPair> Registry;
  
  // -------------------- TO BE DEPRECATED! --------------------
  
  SiStripFedCabling( const std::vector<FedChannelConnection>& );
  
  void buildFedCabling( const std::vector<FedChannelConnection>& );
  
  const std::vector<FedChannelConnection>& connections( uint16_t fed_id ) const; 
  
  const FedChannelConnection& connection( uint16_t fed_id, uint16_t fed_ch ) const; 
  
  const std::vector<uint16_t>& feds() const;
  
  const std::vector<FedChannelConnection>& detected() const; 
  
  const std::vector<FedChannelConnection>& undetected() const; 
  
  // -------------------- Constructors, destructors --------------------
  
  SiStripFedCabling( ConnsConstIterRange );
  
  SiStripFedCabling( const SiStripFedCabling& ); 
  
  SiStripFedCabling();

  ~SiStripFedCabling();

  // -------------------- Methods to retrieve connections --------------------

  FedsConstIterRange fedIds() const;
  
  ConnsConstIterRange fedConnections( uint16_t fed_id ) const; 
  
  FedChannelConnection fedConnection( uint16_t fed_id, uint16_t fed_ch ) const; 
  
  ConnsConstIterRange detectedDevices() const; 
  
  ConnsConstIterRange undetectedDevices() const; 

  // -------------------- Utility methods --------------------
  
  void buildFedCabling( ConnsConstIterRange connections );
  
  void printDebug( std::stringstream& ) const;

  void print( std::stringstream& ss ) const {
    printDebug(ss);
  }
  
  void terse( std::stringstream& ) const;
  
  void printSummary( std::stringstream& ) const;
  void summary( std::stringstream& ss ) const {
    printSummary(ss);
  }

  class ConnsRange {

  public:
    
    ConnsRange( const Conns&, ConnsPair );
    ConnsRange( const Conns& );
    ConnsRange() {;}
    
    ConnsConstIter begin() const;
    ConnsConstIter end() const;
    ConnsConstIterRange range() const;
    ConnsConstIterRange invalid() const;
    
    bool empty() const;
    uint32_t size() const;

    ConnsPair connsPair() const;
    static ConnsPair emptyPair();

    void print( std::stringstream& ) const;
    
  private:
    
    ConnsConstIterRange vector_;
    ConnsConstIterRange range_;

  };

  ConnsRange range( ConnsPair ) const;
  
  // -------------------- Private member data --------------------

 private:

  Feds feds_;
  
  Registry registry_;
  
  Conns connections_;

  Conns detected_;
  
  Conns undetected_;

};

std::ostream& operator<<( std::ostream&, const SiStripFedCabling::ConnsRange& );

inline SiStripFedCabling::FedsConstIterRange SiStripFedCabling::fedIds() const {
  return FedsConstIterRange( feds_.begin(), feds_.end() );
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::detectedDevices() const { 
  return ConnsConstIterRange( detected_.begin(), detected_.end() ); 
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::undetectedDevices() const{ 
  return ConnsConstIterRange( undetected_.begin(), undetected_.end() ); 
}

inline SiStripFedCabling::ConnsConstIter SiStripFedCabling::ConnsRange::begin() const { 
  return range_.begin(); 
}

inline SiStripFedCabling::ConnsConstIter SiStripFedCabling::ConnsRange::end() const { 
  return range_.end(); 
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::ConnsRange::range() const { 
  return range_;
}

inline SiStripFedCabling::ConnsConstIterRange SiStripFedCabling::ConnsRange::invalid() const { 
  return ConnsConstIterRange( vector_.end(), vector_.end() );
}

inline bool SiStripFedCabling::ConnsRange::empty() const { 
  return ( range_.begin() == range_.end() );
}

inline uint32_t SiStripFedCabling::ConnsRange::size() const { 
  return std::distance( range_.begin(), range_.end() );
}

inline SiStripFedCabling::ConnsPair SiStripFedCabling::ConnsRange::connsPair() const { 
  return ( ( range_.begin() == vector_.end() && 
         range_.end()   == vector_.end() ) ?
       ConnsPair( sistrip::invalid32_, sistrip::invalid32_ ) :
       ConnsPair( std::distance( vector_.begin(), range_.begin() ), 
              std::distance( vector_.begin(), range_.end() ) ) );
}

inline SiStripFedCabling::ConnsPair SiStripFedCabling::ConnsRange::emptyPair() { 
  return ConnsPair( sistrip::invalid32_, sistrip::invalid32_ );
}

inline SiStripFedCabling::ConnsRange SiStripFedCabling::range( SiStripFedCabling::ConnsPair p ) const {
  return ConnsRange( connections_, p );
}


// -------------------------------------------------------------
#endif // SISTRIPCABLING_USING_NEW_INTERFACE -------------------
#endif // SISTRIPCABLING_USING_NEW_STRUCTURE -------------------
// -------------------------------------------------------------

#endif // CondFormats_SiStripObjects_SiStripFedCabling_H