sml/rasterobject.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file sml/rasterobject.h
 * \brief SML RASTEROBJECT
 *
 * \if NODOC
 * $Log: rasterobject.h_v $
 * Revision 1.4  2007/11/12 16:11:40  scowan
 * Removed legacy image statistics handling methods.
 *
 * Revision 1.3  2007/11/09 17:54:37  dwilliss
 * got rid of some unused members
 * Commented some methods that can go away after next full build
 *
 * Revision 1.2  2007/05/08 15:46:16  dwilliss
 * SML namespace
 *
 * Revision 1.1  2007/05/04 21:07:17  dwilliss
 * Initial revision
 *
 * \endif
*/
/*****************************************************************************/

#ifndef INC_SML_RASTEROBJECT_H
#define INC_SML_RASTEROBJECT_H

#ifndef INC_SML_OBJECT_H
#include <sml/object.h>
#endif

#ifndef INC_RVC_IMAGE_H
#include <rvc/image.h>
#endif

#ifdef RVCSYSDLL
   #define RVCSYSLIBEXPORT MI_DLLEXPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCSYSLIBEXPORT MI_DLLIMPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RVC {
   class RASTER;
   class RASTERHANDLE;
   }
#endif

namespace SML {
#ifndef GENERATING_DOXYGEN_OUTPUT
class RASTBUF;
#endif

/*****************************************************************************/
class RVCSYSLIBCLASSEXPORT RASTEROBJECT : public OBJECT {
   public:

      int GetCurLin (
         ) const;

      int GetCurCol (
         ) const;

      RVC::RASTER* GetInterface (
         ) const;

      bool GetNullKnown (
         ) const;

      double GetNullValue (
         ) const;

      DEPRECATED int GetNumBits (
         ) const;

      int GetNumCols (
         ) const;

      int GetNumLins (
         ) const;

      bool GetUseNull (
         ) const;

      DEPRECATED int GetDataType (
         ) const;

      void InvalidateImageStats (
         );

      void SetCurCol (
         int col
         );

      void SetCurLin (
         int lin
         );

      // This method should go away after 10 Nov 07 -- nothing calles it now.
      void SetHistoRead (
         bool known
         );

      void SetInterface (
         RVC::RASTER* obj
         );

      void SetMaxValue (
         double val
         );

      void SetMinValue (
         double val
         );

      void SetNullKnown (
         bool known
         );

      void SetNullValue (
         double val
         );

      void SetUseNull (
         bool use
         );

      void SetupRaster (
         );

      int Flush (
         );

      double ReadCell (
         int lin,
         int col
         );

      int ReadCell (
         int lin,
         int col,
         double* pval
         );

      int WriteCell (
         int lin,
         int col,
         double val
         );

      int WriteSpan (
         int lin,
         int startcol,
         int endcol,
         double val
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      RASTEROBJECT (
         CONTEXT* context
         );

      virtual ~RASTEROBJECT (
         );

      virtual int v_OpenLow (
         int mode
         );

      virtual void v_CloseLow (
         );

      virtual RVC::OBJTYPE v_GetObjType (
         ) const;

      int AddBuffer (
         );

      int FindBuffer (
         int lin,
         int col,
         UINT32 flags,
         RASTBUF** pbuf
         );

      RVC::RASTERHANDLE* GetHandle (
         ) const { return m_handle; }

      INT32 m_numlins;
      INT32 m_numcols;
      INT32 m_TileCols;
      INT32 m_datatype;
      INT32 m_numbits;

      RASTBUF *m_pBufList;
      int m_hit, m_miss, m_numbufs;
      double m_nullval;
      double m_min, m_max;
      bool m_UseNull;
      bool m_bUserSetUseNull;
      bool m_NullKnown;
      RVC::RASTERHANDLE* m_handle;
      RVC::RASTERHANDLE* m_NullMaskHandle;

      friend class CONTEXT;      
      friend class OBJECT;       
      friend class VM;        
#endif // GENERATING_DOXYGEN_OUTPUT
   };
} // end of SML namespace


typedef SML::RASTEROBJECT SMLRASTEROBJECT;

/*****************************************************************************/

#define QQCurRastSymLin(sym) ((sym)->m_obj->GetCurElemNum((ELEMTYPE)0))
#define QQCurRastSymCol(sym) ((sym)->m_obj->GetCurElemNum((ELEMTYPE)1))


#undef RVCSYSLIBEXPORT
#undef RVCSYSLIBCLASSEXPORT

#endif      //  INC_SML_RASTEROBJECT_H

---