CoordRange.h

Go to the documentation of this file.

#ifndef SZA_UTIL_COORDRANGE_H
#define SZA_UTIL_COORDRANGE_H

#include "carma/szautil/Coord.h"

#include <iostream>

namespace sza {
  namespace util {
    
    // Class for managing a range of a coordinate axis

    class CoordRange {
    public:
      
      CoordRange();
      CoordRange(unsigned index);
      CoordRange(unsigned iStart, unsigned iStop);
      CoordRange(Coord& start, Coord& stop);
      CoordRange(Coord& coord);
      CoordRange(CoordRange* coordRange);
      
      void initialize();

      virtual ~CoordRange();
      
      void setStartIndex(unsigned iAxis, unsigned iStart);
      unsigned startIndex(unsigned iAxis);

      // Set the start coordinate

      void setStartCoord(Coord& startCoord);
      void setStartCoord(Coord* startCoord);

      // Get the start coord

      Coord startCoord();

      void setStopIndex(unsigned iAxis, unsigned iStop);
      unsigned stopIndex(unsigned iAxis);

      // Set both the stop and start to the same index

      void setIndex(unsigned iAxis, unsigned index);

      // Same as above, but defaults to axis 0

      void setIndex(unsigned index);

      // Set the stop coordinate

      void setStopCoord(Coord& stopCoord);
      void setStopCoord(Coord* stopCoord);

      // Get the stop coord

      Coord stopCoord();

      void setCoord(Coord coord);

      unsigned nEl(unsigned iAxis);

      unsigned nAxis();

      bool isValid();

      void setContiguous(bool contiguous);
      bool isContiguous();

      friend std::ostream& operator<<(std::ostream& os, CoordRange range);

      CoordRange& operator+=(unsigned incr);

      bool operator==(CoordRange& range);

      // Return true if this range contains the passed range

      bool contains(CoordRange& range);

    private:

      Coord startCoord_;
      Coord stopCoord_;

      bool contiguous_;

    }; // End class CoordRange
    
  } // End namespace util
} // End namespace sza



#endif // End #ifndef SZA_UTIL_COORDRANGE_H