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

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

+ Inheritance diagram for Export:

Public Member Functions

def __init__ (self, file, format=DataFormat.auto, filter=None, control=None, collectHdrContents=False, invalidHeight=1.7976931348623157e+308)
 creates new export object More...
 
def close (self)
 
def getControlObject (self)
 
def getFileFormat (self)
 
def getFilename (self)
 
def getFilter (self)
 
def getHeader (self)
 
def removeFile (self)
 
def setBoundingBox (self, arg1)
 
def setCRS (self, arg1)
 
def setControlObject (self, arg1)
 
def setFilter (self, arg1)
 
def write (self, arg1)
 

Static Public Member Functions

def create (file, format=DataFormat.auto, filter=None, control=None, collectHdrContents=False, invalidHeight=1.7976931348623157e+308)
 creates new export object More...
 

Detailed Description

base class for exporting original geometry data file

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  file,
  format = DataFormat.auto,
  filter = None,
  control = None,
  collectHdrContents = False,
  invalidHeight = 1.7976931348623157e+308 
)

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)

Reimplemented in ExportShape.

Member Function Documentation

◆ close()

def close (   self)
Parameters
self(type: Export) self pointer

◆ create()

def create (   file,
  format = DataFormat.auto,
  filter = None,
  control = None,
  collectHdrContents = False,
  invalidHeight = 1.7976931348623157e+308 
)
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)

Reimplemented in ExportShape.

◆ getControlObject()

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

◆ getFileFormat()

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

◆ getFilename()

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

◆ getFilter()

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

◆ getHeader()

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

◆ removeFile()

def removeFile (   self)
Parameters
self(type: Export) self pointer
Returns
(type: bool)

◆ setBoundingBox()

def setBoundingBox (   self,
  arg1 
)
Parameters
self(type: Export) self pointer
arg1(type: Box) mandatory parameter

◆ setControlObject()

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

◆ setCRS()

def setCRS (   self,
  arg1 
)
Parameters
self(type: Export) self pointer
arg1(type: str) mandatory parameter

◆ setFilter()

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

◆ write()

def write (   self,
  arg1 
)
Parameters
self(type: Export) self pointer
arg1(type: object) mandatory parameter