Isis 3.0 Object Programmers' Reference

Home

---

Buffer.h

Go to the documentation of this file.

#ifndef Buffer_h
#define Buffer_h

#include "iException.h"
#include "PixelType.h"

namespace Isis {
  class Buffer {
    public:
      Buffer();
      Buffer(const int nsamps, const int nlines, const int nbands,
             const Isis::PixelType type);

      ~Buffer();

      Buffer (const Buffer &);

      Buffer &operator=(const double &d);
  
      inline int SampleDimension() const { return (p_nsamps); }

      inline int LineDimension() const { return (p_nlines); }

      inline int BandDimension() const { return (p_nbands); }

      inline int size() const { return (p_npixels); }
  
      // Methods which return absolute coordinates relative to the buffer
      int Sample(const int index = 0) const;
      int Line(const int index = 0) const;
      int Band(const int index = 0) const;
      void Position(const int index, int &i_samp, int &i_line, int &i_band) const;
      int Index(const int i_samp, const int i_line, const int i_band) const
                throw(Isis::iException &);
  
      // Methods which give info about the buffer or its contents
      double at(const int index) const;

      inline double &operator[](const int index) { return (p_buf[index]); }

      inline double *DoubleBuffer() const { return (p_buf); };
      void Copy (const Buffer &in);
  
      void *RawBuffer() const { return p_rawbuf; };

      Isis::PixelType PixelType () const { return p_pixelType; };
  
    protected:
      void SetBasePosition(const int start_sample, const int start_line,
                           const int start_band);

      inline void SetBaseSample(const int start_samp)
                  { p_sample = start_samp; return; }

      inline void SetBaseLine(const int start_line)
                  { p_line = start_line; return; }

      inline void SetBaseBand(const int start_band)
                  { p_band = start_band; return; }

      int p_sample;   
      int p_nsamps;   
                     
      int p_line;     
      int p_nlines;   
                     
      int p_band;     
      int p_nbands;   
                     
      int p_npixels;  
      double *p_buf;  
      const Isis::PixelType p_pixelType;  
      void *p_rawbuf;                     

      void Allocate();

      Buffer &operator=(const Buffer &rvalue) { 
        return const_cast<Buffer &>(rvalue); 
      };

  };
};

#endif