CorrelatorBand.h

#ifndef SZA_UTIL_CORRELATORBAND_H
#define SZA_UTIL_CORRELATORBAND_H

#include <iostream>
#include <sstream>
#include <string>

#include "carma/szautil/Directives.h"
#include "carma/szautil/Frequency.h"

namespace sza {
  namespace util {
    
    class CorrelatorBand {
      
      //------------------------------------------------------------
      // Public members
      //------------------------------------------------------------
      
    public:
      
      // The total number of 500 MHz bands
      
      static const unsigned int NBAND = 16;
      
      // Each 500 MHz band is correlated in NCHAN channels.  The lag
      // correlator actually produces 17 channels, but the end points
      // are aliased.  We will pack only the central N-2 bands
      
      static const unsigned int NCHAN_TOTAL = 17;
      
      enum Id {
        BANDNONE = 0x0, // Make these orthogonal bits, so we can OR
                        // them together.
        BAND0    = 0x1,
        BAND1    = 0x2,
        BAND2    = 0x4,
        BAND3    = 0x8,
        BAND4    = 0x10,
        BAND5    = 0x20,
        BAND6    = 0x40,
        BAND7    = 0x80,
        BAND8    = 0x100,
        BAND9    = 0x200,
        BAND10   = 0x400,
        BAND11   = 0x800,
        BAND12   = 0x1000,
        BAND13   = 0x2000,
        BAND14   = 0x4000,
        BAND15   = 0x8000,
        BANDMAX  = BAND15, // This should always be set to the last valid band
        BANDALL  = 0xFFFF,
      } id_;
      
      CorrelatorBand(Id id);
      
      CorrelatorBand(unsigned int);
      
      CorrelatorBand();
      
      CorrelatorBand(const CorrelatorBand& band);
      
      bool isValidSingleBand();
      
      std::string bandName();
      static std::string bandName(unsigned iBand);
      
      void setId(CorrelatorBand::Id id);
      
      unsigned int getIntId();
      
      unsigned short getDcBandIndex();
      unsigned short getDcNodeIndex();
      
      unsigned int getBandMax();
      
      bool isSet(CorrelatorBand::Id id);
      
      bool isSet(CorrelatorBand& band);
      
      //------------------------------------------------------------
      // Member operators
      //------------------------------------------------------------
      
      const CorrelatorBand operator+(const CorrelatorBand& band);
      
      bool operator<(const CorrelatorBand band);
      
      bool operator<=(const CorrelatorBand band);
      
      bool operator>(const CorrelatorBand band);
      
      bool operator>=(const CorrelatorBand band);
      
      bool operator==(const CorrelatorBand band);
      
      const CorrelatorBand& operator++();
      
      const CorrelatorBand operator++(int);
      
      //------------------------------------------------------------
      // Non-member operator methods
      //------------------------------------------------------------
      
      friend std::ostream& operator<<(std::ostream& os, const CorrelatorBand& band);
      
      friend std::ostringstream& operator<<(std::ostringstream& os, 
                                            const CorrelatorBand& band);
      friend CorrelatorBand::Id operator+(const CorrelatorBand::Id id1, 
                                          const CorrelatorBand::Id id2);
      
      static Frequency bandWidth();
      
      static Frequency bandWidthPerChannel();
      
      //------------------------------------------------------------
      // Private members
      //------------------------------------------------------------
      
    private:
      
      // The bandwidth of a band
      
      static const Frequency bandWidth_;
      
      // The bandwidth of a single channel
      
      static const Frequency bandWidthPerChannel_;
      
      bool isValid(unsigned int band);
      
      Id intToId(unsigned int iband);
      
      void checkMaxBand();
      
    }; // End class CorrelatorBand
    
    std::ostream& operator<<(std::ostream& os, const CorrelatorBand& band);
    
    std::ostringstream& operator<<(std::ostringstream& os, 
                                   const CorrelatorBand& band);
    CorrelatorBand::Id operator+(const CorrelatorBand::Id id1, 
                                 const CorrelatorBand::Id id2);
    
  }; // End namespace util
}; // End namespace sza

#endif