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

#pragma once
 
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
#include "DM/IControlObject.hpp"
#include "DM/IFilter.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/IBox.hpp"
 
#include "DM/IO/IFileHeader.hpp"
#include "DM/IO/DataFormat.hpp"
 
#include "DM/Log.hpp"
#include "DM/IO/DataFormat.hpp"
 
//stl
#include <memory>
 
#include <float.h>
 
DM_NAMESPACE_BEGIN
 
class DM_API IDatamanager;
 
enum struct ExportError
{
  noDataToWrite = -7,         ///< no data to write
  exportStreamNotAccessible,  ///< export stream is not accessible
  writingHeaderFailure,       ///< error while writing the header
  writingDataFailure,         ///< error while writing data
  exportStreamClosed,         ///< export stream already closed
  exportLimitReaced,          ///< export limit is reached
  interrupted,                ///< export was interrupted 
  successful = 1              ///< no error occurred
};
 
DM_API const char* toString(ExportError error);   ///< get a textual description of an export error (this function is not thread safe)
 
/// behaviour in case two consecutive lines have the same winput code (and structure line number)
enum struct ExportWinputSeparator
{
  insertSeparatorCode = 0,  ///< correct solution based on winput specification (but doesn't work in gve)
  insertMassPoint,          ///< work-a-round for gve by duplicating the line start point as mass point
  throwExpection            ///< throw excpetion 
};
 
 
/// \brief base class for exporting original geometry data file
class DM_API IExport : public ObjectBase 
{
public:
  /// \brief creates new export object
  /**
    interface for exporting geometry objects for different file formats. if not specified the function estimates the file format
    based on the file extension.
    \param[in]  file                filename
    \param[in]  format              defines file format or use null for auto detection based on file extension
    \param[in]  filter              filter for subselecting/transforming objects during export
    \param[in]  control             control object for retrieving export progress information
    \param[in]  collectHdrContents  flag for explicitly collecting header information while exporting
    \param[in]  invalidHeight       height value that defines an invalid height (ie. no data value)
  */
  static IExport* New( const char *file, DM::DataFormat format = DM::DataFormat::null,
                       const FilterHandle filter = FilterHandle(),
                       ControlObjectHandle control = ControlObjectHandle(),
                       bool collectHdrContents = false, double invalidHeight = DBL_MAX );
  
  /// The export object holds a handle to the manager object, securing its life time
  static IExport* NewODM( Handle< IDatamanager > manager, bool preserveFileLayerInfo, const FilterHandle filter = FilterHandle(), 
                          ControlObjectHandle control = ControlObjectHandle(), bool collectHdrContents = false, 
                          unsigned maxBulkPoints = 1000, bool cloneAddInfos = true);
  static IExport* NewODM( std::shared_ptr< IDatamanager > manager, bool preserveFileLayerInfo, const FilterHandle filter = FilterHandle(), 
                          ControlObjectHandle control = ControlObjectHandle(), bool collectHdrContents = false, 
                          unsigned maxBulkPoints = 1000, bool cloneAddInfos = true);
  /// The export only stores a reference to the manager. hence it's the programmers responsiblity to secure its life time
  static IExport* NewODM( IDatamanager &manager, bool preserveFileLayerInfo, const FilterHandle filter = FilterHandle(), 
                          ControlObjectHandle control = ControlObjectHandle(), bool collectHdrContents = false, 
                          unsigned maxBulkPoints = 1000, bool cloneAddInfos = true);
  
  /// Create an full waveform export 
  static IExport* NewFWF( const char *filename, unsigned versionMajor = 1, unsigned versionMinor = 0, bool binary = false, 
                const FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(),
                bool collectHdrContents = false, bool append = false, int decimals = 3, int coordFieldWidth = 12,
                bool echoWidthIsSigmaOfFit = true);
 
  /// Create an full waveform export 
  static IExport* NewSDW( const char *filename, unsigned versionMajor = 1, unsigned versionMinor = 0,
                const FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(),
                double invalidHeight = DBL_MAX );
 
  /// Create a winput export
  static IExport* NewWinput( const char *filename, bool binary, DM::ColumnSemantic structIdAddInfoCol = DM::ColumnSemantic::null,
                          ExportWinputSeparator separator = ExportWinputSeparator::insertSeparatorCode,
                          FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                          bool collectHdrContents = false, bool append = false );
 
 
protected:
  virtual ~IExport() {}
 
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;
 
  // Export objects may benefit from knowing the data extents beforehand,
  // e.g. NG_ExportLAS will better estimate coordinate reduction and scaling to internal representation
  // This info cannot be passed in the base Ctor, as headers are allocated in the Ctor's of descendant export classes only if needed.
  virtual void setBoundingBox( BoxHandle box ) = 0;
 
 
  /// Retuns the filename 
  virtual const char* getFilename() const = 0;
 
  /// Retuns the file format
  virtual DataFormat getFileFormat() const = 0;
 
  /// Set logging call back function
  virtual void logTo( LogFn logFn ) = 0;
 
  /// write next object to the export object
  virtual ExportError writeNext(const GeometryHandle &obj) = 0; 
 
  /// close open file(s)
  virtual void close() = 0;
 
  /// remove files
  virtual bool removeFile() = 0;
 
  /// set coordinate reference system using a wkt string
  virtual void setCRS(const char *crs) = 0;
};
 
typedef Handle<IExport> ExportHandle;
 
DM_NAMESPACE_END