M/c++_api/inc/DM/IO/IImport.hpp

#ifndef DM_IO_IIMPORT_HPP_INCLUDED
#define DM_IO_IIMPORT_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink

#include "DM/IControlObject.hpp"
#include "DM/IFilter.hpp"
#include "DM/IAddInfoLayout.hpp"

#include "DM/IO/IFileHeader.hpp"

#include "DM/Log.hpp"
#include "DM/IO/DataFormat.hpp"

DM_NAMESPACE_BEGIN

namespace ImportError {
  enum Type {
    demoLimitExceeded = -9,     ///< demo limit of the DM exceeded
    unknownFormat,              ///< unknown import file format
    memoryOverflow,             ///< memory overflow occurred
    importStreamNotAccessible,  ///< import stream is not accessible
    headerContentsErroneous,    ///< the file header content is erroneous 
    readingData,                ///< general error while reading data
    importStreamClosed,         ///< import stream was already closed
    endOfStreamReached,         ///< end of input stream is reached
    interrupted,                ///< import was interrupted 
    successful = 1              ///< no error occured
  };

  DM_API const char* toString(Type error);    ///< get a textual description of an import error (this function is not thread safe)
}

namespace PolygonMerging {
  enum Type {
    safe = 0, ///< incremental merge of polygon parts (slow but robust)
    fast = 1  ///< build polygon object at once (fast but fails in case of topological incorrect polygon parts)
  };
}

class DM_API IDatamanager;

class DM_API IImport : public ObjectBase 
{
public:
  static IImport* New( void *instance, const char *file, DataFormat::Type format, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                       bool collectHdrContents = false, unsigned maxBulkPoints = 1000, AddInfoLayoutHandle defaultLayout = AddInfoLayoutHandle() );

  static IImport* New( const char *file, DataFormat::Type format, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                       bool collectHdrContents = false, unsigned maxBulkPoints = 1000, AddInfoLayoutHandle defaultLayout = AddInfoLayoutHandle() );

  /// deprecated odm import creation functions (use IImportODM::New instead)
  static IImport* NewODM( Handle< IDatamanager > manager, bool restoreOrder, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(),
                          bool collectHdrContents = false, unsigned maxBulkPoints = 1000 );
  /// deprecated odm import creation functions (use IImportODM::New instead)
  static IImport* NewODM( IDatamanager &manager, bool restoreOrder, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(),
                          bool collectHdrContents = false, unsigned maxBulkPoints = 1000 );

  static IImport* NewGDAL( const char *file, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                          bool collectHdrContents = false, unsigned maxBulkPoints = 1000,
                          unsigned bandNumber = 1, const char *driver = 0 );

  static IImport* NewWinput( const char *file, bool binary, DM::ColumnSemantic::Type structIdAddInfoCol = DM::ColumnSemantic::null, 
                          DM::ColumnSemantic::Type wnpCodeAddInfoCol = DM::ColumnSemantic::null, 
                          FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                          bool collectHdrContents = false, unsigned maxBulkPoints = 1000,
                          AddInfoLayoutHandle layout = AddInfoLayoutHandle() );


  struct InvalidObjectStatistic {
    long long polygonsInvalidOrientation; ///< number of polygons that are orientated incorrectly
    long long polygonsSelfIntersecting;   ///< number of polygons that are self intersecting
  };

  /// Store the string representation of the import object in representation and return the length of representation.
  /// Memory for representation must be allocated externally.
  /// Pass a null pointer to query the length of representation only.
  /// Note that the stored representation may contain null bytes.
  virtual unsigned serialize( char *representation = 0 ) const = 0;

  /// Restore an import object from its string representation. Since the representation may contain null bytes, its size must also be specified.
  static IImport* unserialize( const char *representation, unsigned repSize );

protected:
  virtual ~IImport() {}

public:
  virtual void setControlObject(ControlObjectHandle control) = 0;
  virtual ControlObjectHandle getControlObject() const = 0;

  //get the file header object
  virtual FileHeaderHandle getHeader() const = 0;

  virtual void setFilter( FilterHandle filter ) = 0;
  virtual FilterHandle getFilter() const = 0;

  virtual void setPolygonMerging(PolygonMerging::Type mode) = 0;
  virtual PolygonMerging::Type getPolygonMerging() const = 0;

  /// Retuns the filename 
  virtual const char* getFilename() const = 0;

  /// Retuns the file format
  virtual DataFormat::Type getFileFormat() const = 0;

  /// Set logging call back function
  virtual void logTo( LogFn logFn ) = 0;

  /// read the header in advance
  virtual bool readHeaderSeparately() = 0;

  /// read next object from import object
  virtual ImportError::Type readNext(GeometryHandle &obj) = 0; 

  /// get a statistic of invalid geometries (after import)
  virtual InvalidObjectStatistic getInvalidGeometries() const = 0;
};

typedef Handle<IImport> ImportHandle;

DM_NAMESPACE_END

#endif //DM_IO_IIMPORT_HPP_INCLUDED