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

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

+ Inheritance diagram for Import:

Public Member Functions

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 create (file, format=DataFormat.auto, filter=None, control=None, collectHdrContents=False, maxBulkPoints=1000, defaultLayout=None)
 creates new import object More...
 

Detailed Description

base class for importing original geometry data file

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  file,
  format = DataFormat.auto,
  filter = None,
  control = None,
  collectHdrContents = False,
  maxBulkPoints = 1000,
  defaultLayout = None 
)

creates new import object

interface for importing geometry objects for different file formats. if not specified the function automatically detects the file format based on the file content.

Parameters
[in]filefilename
[in]formatdefines file format or use null for auto detection
[in]filterfilter for subselecting/transforming objects during import
[in]controlcontrol object for retrieving import progress information
[in]collectHdrContentsflag for explicitly collecting header information while importing
[in]maxBulkPointschunk size for bulk points being imported at once
[in]defaultLayoutdefault attribute layout for objects while importing (attribute stored within the file, will be extended to this layout)

Member Function Documentation

◆ create()

def create (   file,
  format = DataFormat.auto,
  filter = None,
  control = None,
  collectHdrContents = False,
  maxBulkPoints = 1000,
  defaultLayout = None 
)
static

creates new import object

interface for importing geometry objects for different file formats. if not specified the function automatically detects the file format based on the file content.

Parameters
[in]filefilename
[in]formatdefines file format or use null for auto detection
[in]filterfilter for subselecting/transforming objects during import
[in]controlcontrol object for retrieving import progress information
[in]collectHdrContentsflag for explicitly collecting header information while importing
[in]maxBulkPointschunk size for bulk points being imported at once
[in]defaultLayoutdefault attribute layout for objects while importing (attribute stored within the file, will be extended to this layout)

◆ getControlObject()

def getControlObject (   self)
Parameters
self(type: Import) self pointer
Returns
(type: ControlObject)

◆ getFileFormat()

def getFileFormat (   self)
Parameters
self(type: Import) self pointer
Returns
(type: DataFormat)

◆ getFilename()

def getFilename (   self)
Parameters
self(type: Import) self pointer
Returns
(type: str)

◆ getFilter()

def getFilter (   self)
Parameters
self(type: Import) self pointer
Returns
(type: Filter)

◆ getHeader()

def getHeader (   self)
Parameters
self(type: Import) self pointer
Returns
(type: FileHeader)

◆ getInvalidGeometries()

def getInvalidGeometries (   self)
Parameters
self(type: Import) self pointer
Returns
(type: InvalidObjectStatistic)

◆ getPolygonMerging()

def getPolygonMerging (   self)
Parameters
self(type: Import) self pointer
Returns
(type: object)

◆ next()

def next (   self)

python 2.x increment iterator support for importing file in a for loop

Parameters
self(type: Import) self pointer
Returns
(type: object)

Referenced by tileManager.__next__().

◆ prepareForReading()

def prepareForReading (   self)
Parameters
self(type: Import) self pointer

◆ read()

def read (   self)

read an object from file

Parameters
self(type: Import) self pointer
Returns
(type: object)

◆ readHeaderSeparately()

def readHeaderSeparately (   self)
Parameters
self(type: Import) self pointer
Returns
(type: bool)

◆ setControlObject()

def setControlObject (   self,
  arg1 
)
Parameters
self(type: Import) self pointer
arg1(type: ControlObject) mandatory parameter

◆ setFilter()

def setFilter (   self,
  arg1 
)
Parameters
self(type: Import) self pointer
arg1(type: Filter) mandatory parameter

◆ setPolygonMerging()

def setPolygonMerging (   self,
  arg1 
)
Parameters
self(type: Import) self pointer
arg1(type: object) mandatory parameter