spatmod/imagetargetfile.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGETARGETFILE_H
#define  INC_SPATMOD_IMAGETARGETFILE_H

#ifndef  INC_SPATMOD_IMAGETARGET_H
#include <spatmod/imagetarget.h>
#endif

#ifndef  INC_SPATMOD_IMAGEFORMAT_H
#include <spatmod/imageformat.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
#include <mi32/filepath.h>
#endif

#ifndef  INC_MI32_RECT_H
#include <mi32/rect.h>
#endif

#ifndef  INC_MI32_DELEGATE_H
#include <mi32/delegate.h>
#endif

class STATUSCONTEXT;

namespace SPATMOD {
namespace IMAGE {

//=====================================================================================================================

class TARGET_FILE : public TARGET {
   public:

      enum GEOFORMATS {
         GEOFORMAT_None =        0x0000,
         GEOFORMAT_ArcWorld =    0x0001,
         GEOFORMAT_KML =         0x0002,
         GEOFORMAT_AUX =         0x0004,
         GEOFORMAT_ALL =         0x00FF,
         GEOFORMAT_ForceKML =    0x8000   
         };

      class TILEPARMS {
         public:

            TILEPARMS ();

            typedef fastdelegate::FastDelegate<ERRVALUE(INT32 TileColumn, INT32 TileRow, FILEPATH&, const LRECT2D& extent)> DELEGATE_ONTILEADD;

            void SetAutoTrim (
               bool AutoTrim = true
               ) { m_AutoTrim = AutoTrim; }

            void SetDelegateOnTileAdd (
               DELEGATE_ONTILEADD delegate
               ) { m_DelegateOnTileAdd = delegate; }

            void SetDelegateOnTileEnd (
               DELEGATE_ERRVALUE_NOPARMS delegate
               ) { m_DelegateOnTileEnd = delegate; }

            void SetTileDimensions (
               double ColumnsPerTile,
               double RowsPerTile
               ) { m_ColumnsPerTile = ColumnsPerTile; m_RowsPerTile = RowsPerTile; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            DELEGATE_ONTILEADD m_DelegateOnTileAdd;
            DELEGATE_ERRVALUE_NOPARMS m_DelegateOnTileEnd;
            bool m_AutoTrim;
            double m_ColumnsPerTile;
            double m_RowsPerTile;

            friend class IMAGE::TARGET_FILE;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };

      TARGET_FILE (
         STAGE *pInputStage,                    
         const FILEPATH& filepath,              
         GEOFORMATS GeoFormats = GEOFORMAT_None 
         );

      TARGET_FILE (
         STAGE *pInputStage,                    
         GEOFORMATS GeoFormats = GEOFORMAT_None 
         );

      virtual ~TARGET_FILE ();

      void* DetachBuffer (
         ) { return (v_DetachBuffer()); }

      const void* GetBuffer (
         ) const { return (v_GetBuffer()); }

      INT64 GetBufferSize (
         ) const { return (v_GetBufferSize()); }

      const FILEPATH& GetFilePath (
         ) const { return (m_filepath); }

      GEOFORMATS GetGeoFormats (
         ) const { return (m_GeoFormats); }

      bool IsOneTilePerFile (
         ) const { return (m_IsOneTilePerFile); }

      bool QueryGeoFormat (
         GEOFORMATS GeoFormat,                  
         MISTRING& message                      
         ) const;

      void SetTileParms (
         const TILEPARMS& TileParms
         );

   protected:

      ERRVALUE WriteGeoFormats ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      FILEPATH m_filepath;
      GEOFORMATS m_GeoFormats;
      bool m_IsOneTilePerFile;
      bool m_DidTileBegin;
      TILEPARMS m_TileParms;
      LRECT2D m_CurTileExtents;
      STATUSCONTEXT *m_pStatusContext;

      ERRVALUE NotifyTileAdd (
         INT32 TileColumn,                      
         INT32 TileRow,                         
         FILEPATH& filepath,                    
         LRECT2D& extents                       
         );

      ERRVALUE NotifyTileEnd (
         );

      ERRVALUE WriteGeoFormats (
         const FILEPATH& filepath,              
         const LRECT2D& extent                  
         ) const;

      ERRVALUE WriteGeoArcWorld (const FILEPATH& filepath, const DRECT2D& extent) const;
      ERRVALUE WriteGeoKML (const FILEPATH& filepath, const DRECT2D& extent) const;

      // Unimplemented
      TARGET_FILE (const TARGET_FILE&);
      TARGET_FILE& operator= (const TARGET_FILE&);
      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual void* v_DetachBuffer (
         );

      virtual ERRVALUE v_FillTileRows (
         INT32 NumColumns,
         INT32 NumRows
         ) = 0;

      virtual const void* v_GetBuffer (
         ) const;

      virtual INT64 v_GetBufferSize (
         ) const;

      ERRVALUE v_PushSubSection (const SECTION& SubSection, const BUFFER& buffer);

      virtual ERRVALUE v_TileBegin (
         const FILEPATH& FilePath,
         const LRECT2D& Extents
         ) = 0;

      virtual ERRVALUE v_TileEnd (
         ) = 0;

      virtual ERRVALUE v_WriteSubSection (
         const SECTION& SubSection,
         const BUFFER& buffer
         ) = 0;

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(TARGET_FILE::GEOFORMATS);
#endif

//=====================================================================================================================

class FACTORY_TARGET_FILE {
   public:

      virtual ~FACTORY_TARGET_FILE ();

      FACTORY_TARGET_FILE * Clone (
         ) const { return (v_Clone()); }

      TARGET_FILE * ConstructTarget (
         STAGE *pInputStage,                    
         const FILEPATH& filepath               
         ) const { return (v_ConstructTarget(pInputStage,filepath,m_GeoFormats)); }

      TARGET_FILE * ConstructTarget (
         STAGE *pInputStage,                    
         const FILEPATH& filepath,              
         TARGET_FILE::GEOFORMATS GeoFormats                 
         ) const { return (v_ConstructTarget(pInputStage,filepath,GeoFormats)); }

      FORMAT::SPEC GetFormatSpec (
         ) const { return (m_FormatSpec); }

      void SetGeoFormats (
         TARGET_FILE::GEOFORMATS GeoFormats
         ) { m_GeoFormats = GeoFormats; }

   protected:

      explicit FACTORY_TARGET_FILE (FORMAT::SPEC FormatSpec);

      FACTORY_TARGET_FILE (const FACTORY_TARGET_FILE& rhs);

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      FORMAT::SPEC m_FormatSpec;
      TARGET_FILE::GEOFORMATS m_GeoFormats;

      // Unimplemented.
      FACTORY_TARGET_FILE& operator= (const FACTORY_TARGET_FILE& rhs);
      #endif

      virtual FACTORY_TARGET_FILE * v_Clone () const = 0;

      virtual TARGET_FILE * v_ConstructTarget (
         STAGE *pInputStage,                    
         const FILEPATH& filepath,              
         TARGET_FILE::GEOFORMATS GeoFormats                 
         ) const = 0;

   };

//=====================================================================================================================
}  // End namespace IMAGE
}  // End namespace SPATMOD

#endif   // INC_SPATMOD_IMAGETARGETFILE_H

---