IImportAny Class Referenceabstract

generic import for pretty much any ascii or binary original geometry data file More...

#include "IImportAny.hpp"

+ Inheritance diagram for IImportAny:

Public Member Functions

virtual void setColumnSeparators (const char *separators)=0
 set seperator character (ascii only)
 
virtual void setCommentInitiator (const char *commentInit)=0
 set comment initiator (ascii only)
 
virtual void setDecimalSeparator (char decimalSeparator)=0
 set decimal seperator (ascii only)
 
virtual void skipWhiteSpace (bool skip)=0
 flag if white spaces should be skipped (ascii only)
 
virtual void setHeaderLineCount (unsigned count)=0
 set number of header lines that should be ignored (ascii only)
 
virtual void setHeaderBytes (unsigned count)=0
 set header bytes that should be ignored (binary only)
 
virtual void setEndianness (Endianness endian)=0
 set endianness type (binary only)
 
virtual void setHeaderText (const char *text)=0
 set (optional) header text (ascii and binary)
 
virtual void throwIfXYMissing (bool doThrow)=0
 flag to throw exception if x and y coordinates are not set (ascii and binary)
 
data block

specify the sequence of coordinates and attributes to be imported, and optionally, characters/bytes to be ignored. The order is important!

virtual void addCoordX (ColumnType externalType=ColumnType::count, const char *converterStr=0)=0
 
virtual void addCoordY (ColumnType externalType=ColumnType::count, const char *converterStr=0)=0
 
virtual void addCoordZ (ColumnType externalType=ColumnType::count, const char *converterStr=0)=0
 
virtual void addAttrib (ColumnSemantic attrib, ColumnType externalType=ColumnType::count, const DM::Any &invalidValue=DM::Any(), const char *converterStr=0, const char *quoteStr=0)=0
 
virtual void addAttrib (const char *name, ColumnType internalType, ColumnType externalType=ColumnType::count, const DM::Any &invalidValue=DM::Any(), const char *converterStr=0, const char *quoteStr=0)=0
 
virtual void addSkip (unsigned count=1)=0
 skip count columns (ascii) / bytes (binary)
 
virtual void storeRest (const char *attrName)=0
 ascii only: if present, store the rest of each line following the specified coordinates/attributes as a custom attribute with name 'attrName' of type string
 
- Public Member Functions inherited from IImport
virtual unsigned serialize (char *representation=0) const =0
 
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 setPolygonMerging (PolygonMerging mode)=0
 
virtual PolygonMerging getPolygonMerging () const =0
 
virtual const char * getFilename () const =0
 Returns the filename.
 
virtual DataFormat getFileFormat () const =0
 Returns the file format.
 
virtual void logTo (LogFn logFn)=0
 Set logging call back function.
 
virtual bool readHeaderSeparately ()=0
 read the header in advance
 
virtual ImportError readNext (GeometryHandle &obj)=0
 read next object from import object
 
virtual InvalidObjectStatistic getInvalidGeometries () const =0
 get a statistic of invalid geometries (after import)
 
- Public Member Functions inherited from ObjectBase
virtual void Delete ()
 

Static Public Member Functions

static IImportAnyNew (const char *file, bool ascii, FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000)
 creates new export object More...
 
- Static Public Member Functions inherited from IImport
static IImportNew (const char *file, DataFormat format, FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, AddInfoLayoutHandle defaultLayout=AddInfoLayoutHandle())
 creates new import object More...
 
static IImportNew (void *instance, const char *file, DataFormat format, FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, AddInfoLayoutHandle defaultLayout=AddInfoLayoutHandle())
 creates new import object More...
 
static IImportNewODM (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 IImportNewODM (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 IImportNewGDAL (const char *file, FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, unsigned bandNumber=1, const char *driver=0)
 
static IImportNewWinput (const char *file, bool binary, ColumnSemantic structIdAddInfoCol=ColumnSemantic::null, ColumnSemantic wnpCodeAddInfoCol=ColumnSemantic::null, FilterHandle filter=FilterHandle(), ControlObjectHandle control=ControlObjectHandle(), bool collectHdrContents=false, unsigned maxBulkPoints=1000, AddInfoLayoutHandle layout=AddInfoLayoutHandle())
 
static IImportunserialize (const char *representation, unsigned repSize)
 Restore an import object from its string representation. Since the representation may contain null bytes, its size must also be specified.
 

Detailed Description

generic import for pretty much any ascii or binary original geometry data file

Member Function Documentation

◆ New()

static IImportAny* New ( const char *  file,
bool  ascii,
FilterHandle  filter = FilterHandle(),
ControlObjectHandle  control = ControlObjectHandle(),
bool  collectHdrContents = false,
unsigned  maxBulkPoints = 1000 
)
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]asciiflag if import should read file in ascii mode (true) of in binary mode (false)
[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]maxBulkPointschunk size for bulk points being imported at once