IExport Class Referenceabstract

base class for exporting original geometry data file More...

#include "IExport.hpp"

+ Inheritance diagram for IExport:

Public Member Functions

virtual void setControlObject (ControlObjectHandle control)=0
 
virtual ControlObjectHandle getControlObject () const =0
 
virtual FileHeaderHandle getHeader () const =0
 
virtual void setFilter (FilterHandle filter)=0
 
virtual FilterHandle getFilter () const =0
 
virtual void setBoundingBox (BoxHandle box)=0
 
virtual const char * getFilename () const =0
 Retuns the filename.
 
virtual DataFormat getFileFormat () const =0
 Retuns the file format.
 
virtual void logTo (LogFn logFn)=0
 Set logging call back function.
 
virtual ExportError writeNext (const GeometryHandle &obj)=0
 write next object to the export object
 
virtual void close ()=0
 close open file(s)
 
virtual bool removeFile ()=0
 remove files
 
virtual void setCRS (const char *crs)=0
 set coordinate reference system using a wkt string
 
- Public Member Functions inherited from ObjectBase
virtual void Delete ()
 

Static Public Member Functions

static IExportNew (const char *file, DM::DataFormat format=DM::DataFormat::null, const FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, double invalidHeight=DBL_MAX)
 creates new export object More...
 
static IExportNewODM (Handle< IDatamanager > manager, bool preserveFileLayerInfo, const FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, bool cloneAddInfos=true)
 The export object holds a handle to the manager object, securing its life time.
 
static IExportNewODM (std::shared_ptr< IDatamanager > manager, bool preserveFileLayerInfo, const FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, bool cloneAddInfos=true)
 
static IExportNewODM (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 IExportNewFWF (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 IExportNewSDW (const char *filename, unsigned versionMajor=1, unsigned versionMinor=0, const FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), double invalidHeight=DBL_MAX)
 Create an full waveform export.
 
static IExportNewWinput (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)
 Create a winput export.
 

Detailed Description

base class for exporting original geometry data file

Member Function Documentation

◆ New()

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 
)
static

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.

Parameters
[in]filefilename
[in]formatdefines file format or use null for auto detection based on file extension
[in]filterfilter for subselecting/transforming objects during export
[in]controlcontrol object for retrieving export progress information
[in]collectHdrContentsflag for explicitly collecting header information while exporting
[in]invalidHeightheight value that defines an invalid height (ie. no data value)