PolylineIndex Class Reference

Interface to an polyline and polygon index object managing all non point objects within the datamanager. More...

Public Member Functions

def geometries
 iterate over all geometry objects
def geometries
 iterate over all geometry objects with a specific layout
def geometries
 iterate over subselected geomtries based on a given filter
def geometries
 iterate over subselected geometries based on a given filter with a specific layout
def getGeometry
 get geometry object by its id
def getIndexStatistics
def getLimit
def searchGeometry
def searchGeometry
def searchGeometry
def searchGeometry
def sizeGeometry
def sizePolygon
def sizePolygonPoint
def sizePolyline
def sizePolylinePoint

Detailed Description

Interface to an polyline and polygon index object managing all non point objects within the datamanager.

Member Function Documentation

def geometries (   self)

iterate over all geometry objects

Parameters
self(type: PolylineIndex) self pointer
Returns
(type: collections.Iterable[Geometry])

Referenced by PolylineIndex.geometries().

def geometries (   self,
  layout,
  readOnly = False 
)

iterate over all geometry objects with a specific layout

see DM::IAddInfo::setView for further details

Parameters
selfself pointer
layouta view of the corresponding layout will be set onto each geometry
readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
Returns
python iterator object

References PolylineIndex.geometries().

def geometries (   self,
  filter 
)

iterate over subselected geomtries based on a given filter

see DM::IFilter for further details

Parameters
selfself pointer
filterfilter object for subselection
Returns
python iterator object

References PolylineIndex.geometries().

def geometries (   self,
  filter,
  layout,
  readOnly = False 
)

iterate over subselected geometries based on a given filter with a specific layout

see DM::IFilter and DM::IAddInfo::setView for further details

Parameters
selfself pointer
filterfilter object for subselection
layouta view of the corresponding layout will be set onto each geometry
readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
Returns
python iterator object

References PolylineIndex.geometries().

def getGeometry (   self,
  arg1 
)

get geometry object by its id

Parameters
self(type: PolylineIndex) self pointer
arg1(type: long) mandatory parameter
Returns
(type: object)
def getIndexStatistics (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: IndexStats)
def getLimit (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: Box)
def searchGeometry (   self,
  win,
  mode,
  includeRightBoundary = True 
)
Parameters
self(type: PolylineIndex) self pointer
win(type: Window) mandatory parameter
mode(type: SpatialQueryMode) mandatory parameter
includeRightBoundary(type: bool) optional parameter
Returns
(type: list)

Referenced by PolylineIndex.searchGeometry().

def searchGeometry (   self,
  box,
  mode,
  includeRightBoundary = True 
)
Parameters
self(type: PolylineIndex) self pointer
box(type: Box) mandatory parameter
mode(type: SpatialQueryMode) mandatory parameter
includeRightBoundary(type: bool) optional parameter
Returns
(type: list)

References PolylineIndex.searchGeometry().

def searchGeometry (   self,
  polygon,
  mode 
)
Parameters
self(type: PolylineIndex) self pointer
polygon(type: Polygon) mandatory parameter
mode(type: SpatialQueryMode) mandatory parameter
Returns
(type: list)

References PolylineIndex.searchGeometry().

def searchGeometry (   self,
  nnCount,
  queryPt,
  maxDistance = None 
)
Parameters
self(type: PolylineIndex) self pointer
nnCount(type: int) mandatory parameter
queryPt(type: Point) mandatory parameter
maxDistance(type: float) optional parameter
Returns
(type: list)

References PolylineIndex.searchGeometry().

def sizeGeometry (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: int)
def sizePolygon (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: int)
def sizePolygonPoint (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: int)
def sizePolyline (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: int)
def sizePolylinePoint (   self)
Parameters
self(type: PolylineIndex) self pointer
Returns
(type: int)