CoordAxes.h

Go to the documentation of this file.

#ifndef SZA_UTIL_COORDAXES_H
#define SZA_UTIL_COORDAXES_H

#include <vector>

#include "carma/szautil/Coord.h"
#include "carma/szautil/CoordRange.h"
#include "carma/szautil/Range.h"

namespace sza {
  namespace util {
    
    class CoordAxes { 
    public:
      
      CoordAxes();
      CoordAxes(unsigned nel0);
      CoordAxes(unsigned nel0, unsigned nel1);
      CoordAxes(unsigned nel0, unsigned nel1, unsigned nel2);

      CoordAxes(CoordAxes* regAxes);
      
      void reset();

      void setAxis(unsigned nAxis, unsigned nEl);

      virtual ~CoordAxes();
      
      unsigned int nAxis();

      unsigned int nEl(int axis=-1);

      unsigned int elementOffsetOf(Coord& coord);
      unsigned int elementOffsetOf(Coord* coord);

      Coord coordOf(unsigned element);

      std::vector<Range<unsigned> > getRanges(CoordRange range);
      std::vector<Range<unsigned> > getRanges(CoordRange* range=0);

      bool rangeIsValid(CoordRange& range);
      bool rangeIsValid(CoordRange* range);

      unsigned nEl(CoordRange& range);
      unsigned nEl(CoordRange* range);

      bool operator==(CoordAxes& axes);

      friend std::ostream& operator<<(std::ostream& os, CoordAxes axes);

      void fillRange(CoordRange& range);


    private:

      // The vector in which we store the number of elements per axis

      std::vector<unsigned int> nEl_;

      void privateConstructor();

      void checkValidityOf(Coord& coord);

      /*
       * Find a vector element matching the stop index
       */
      std::vector<Range<unsigned> >::iterator 
        findStopIndex(std::vector<Range<unsigned> >& ranges, unsigned index);
      
      void computeRanges(std::vector<Range<unsigned> >& ranges, unsigned iAxis, 
                         Coord& start, Coord& stop, unsigned offset);
        
      void addNewRange(std::vector<Range<unsigned> >& ranges, 
                       unsigned startIndex, unsigned stopIndex);

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



#endif // End #ifndef SZA_UTIL_COORDAXES_H