Loading [MathJax]/extensions/tex2jax.js
ImportAny Class Reference

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

+ Inheritance diagram for ImportAny:

Public Member Functions

def __init__ (self, file, ascii, filter=None, control=None, collectHdrContents=False, maxBulkPoints=1000)
 creates new generic import object More...
 
def addCoordX (self, externalType=ColumnType(12), converterStr=None)
 
def addCoordY (self, externalType=ColumnType(12), converterStr=None)
 
def addCoordZ (self, externalType=ColumnType(12), converterStr=None)
 
def addSkip (self, arg1)
 skip count columns (ascii) / bytes (binary) More...
 
def setColumnSeparators (self, arg1)
 set seperator character (ascii only) More...
 
def setCommentInitiator (self, arg1)
 set comment initiator (ascii only) More...
 
def setDecimalSeparator (self, arg1)
 set decimal seperator (ascii only) More...
 
def setEndianness (self, arg1)
 set endianness type (binary only) More...
 
def setHeaderBytes (self, arg1)
 set header bytes that should be ignored (binary only) More...
 
def setHeaderLineCount (self, arg1)
 set number of header lines that should be ignored (ascii only) More...
 
def setHeaderText (self, arg1)
 set header bytes that should be ignored (binary only) More...
 
def skipWhiteSpace (self, arg1)
 flag if white spaces should be skipped (ascii only) More...
 
def storeRest (self, arg1)
 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 More...
 
def throwIfXYMissing (self, arg1)
 flag to throw exception if x and y coordinates are not set (ascii and binary) More...
 
- Public Member Functions inherited from Import
def __init__ (self, file, format=DataFormat.auto, filter=None, control=None, collectHdrContents=False, maxBulkPoints=1000, defaultLayout=None)
 creates new import object More...
 
def getControlObject (self)
 
def getFileFormat (self)
 
def getFilename (self)
 
def getFilter (self)
 
def getHeader (self)
 
def getInvalidGeometries (self)
 
def getPolygonMerging (self)
 
def next (self)
 python 2.x increment iterator support for importing file in a for loop More...
 
def prepareForReading (self)
 
def read (self)
 read an object from file More...
 
def readHeaderSeparately (self)
 
def setControlObject (self, arg1)
 
def setFilter (self, arg1)
 
def setPolygonMerging (self, arg1)
 

Static Public Member Functions

def addAttrib (self, *args, **kwargs)
 possible calls: More...
 
def create (file, ascii, filter=None, control=None, collectHdrContents=False, maxBulkPoints=1000)
 creates new generic import object More...
 
- Static Public Member Functions inherited from Import
def create (file, format=DataFormat.auto, filter=None, control=None, collectHdrContents=False, maxBulkPoints=1000, defaultLayout=None)
 creates new import object More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  file,
  ascii,
  filter = None,
  control = None,
  collectHdrContents = False,
  maxBulkPoints = 1000 
)

creates new generic import object

interface for importing point objects in a generic way. The import bascially supports (not to complex) ascii and binary formats.

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

Member Function Documentation

◆ addAttrib()

def addAttrib (   self,
args,
**  kwargs 
)
static

possible calls:

  • addAttrib(self, attrib: ColumnSemantic, externalType: ColumnType, invalidValue: object, converterStr: str)
  • addAttrib(self, name: str, internalType: ColumnType, externalType: ColumnType, invalidValue: object, converterStr: str)
Parameters
self(type: object) self pointer
*args(type: list) mandatory parameter
**kwargs(type: dict) mandatory parameter

◆ addCoordX()

def addCoordX (   self,
  externalType = ColumnType(12),
  converterStr = None 
)
Parameters
self(type: ImportAny) self pointer
externalType(type: ColumnType) optional parameter
converterStr(type: str) optional parameter

◆ addCoordY()

def addCoordY (   self,
  externalType = ColumnType(12),
  converterStr = None 
)
Parameters
self(type: ImportAny) self pointer
externalType(type: ColumnType) optional parameter
converterStr(type: str) optional parameter

◆ addCoordZ()

def addCoordZ (   self,
  externalType = ColumnType(12),
  converterStr = None 
)
Parameters
self(type: ImportAny) self pointer
externalType(type: ColumnType) optional parameter
converterStr(type: str) optional parameter

◆ addSkip()

def addSkip (   self,
  arg1 
)

skip count columns (ascii) / bytes (binary)

◆ create()

def create (   file,
  ascii,
  filter = None,
  control = None,
  collectHdrContents = False,
  maxBulkPoints = 1000 
)
static

creates new generic import object

interface for importing point objects in a generic way. The import bascially supports (not to complex) ascii and binary formats.

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

◆ setColumnSeparators()

def setColumnSeparators (   self,
  arg1 
)

set seperator character (ascii only)

◆ setCommentInitiator()

def setCommentInitiator (   self,
  arg1 
)

set comment initiator (ascii only)

◆ setDecimalSeparator()

def setDecimalSeparator (   self,
  arg1 
)

set decimal seperator (ascii only)

◆ setEndianness()

def setEndianness (   self,
  arg1 
)

set endianness type (binary only)

◆ setHeaderBytes()

def setHeaderBytes (   self,
  arg1 
)

set header bytes that should be ignored (binary only)

◆ setHeaderLineCount()

def setHeaderLineCount (   self,
  arg1 
)

set number of header lines that should be ignored (ascii only)

◆ setHeaderText()

def setHeaderText (   self,
  arg1 
)

set header bytes that should be ignored (binary only)

◆ skipWhiteSpace()

def skipWhiteSpace (   self,
  arg1 
)

flag if white spaces should be skipped (ascii only)

◆ storeRest()

def storeRest (   self,
  arg1 
)

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

◆ throwIfXYMissing()

def throwIfXYMissing (   self,
  arg1 
)

flag to throw exception if x and y coordinates are not set (ascii and binary)