All Cadcorp SIS API Methods

TopoClean Method

Description

Cleans up topological Link Items.

Syntax

Visual Basic
Public Function TopoClean( _
   ByVal list As String, _
   ByVal tolerance As Double, _
   ByVal options As Integer _
) As Integer

Parameters

list
The Named List containing the Link Items to be cleaned.
 
tolerance
The tolerance to use. Link Items whose length is less than this value will be removed. If SIS_CLEAN_TOPO_FIX_UNDER_OVER is specified then Link Items with a dangling end will be joined to another Link item within this distance.
 
options
SIS_CLEAN_TOPO_NONE  Only delete Link Items shorter than tolerance.
SIS_CLEAN_TOPO_REMOVE_DANGLING Delete Link Items which are not joined to other Link Items, regardless of their length.
SIS_CLEAN_TOPO_FIX_UNDER_OVER Close small gaps, and delete small dangling Link Items.
SIS_CLEAN_TOPO_REMOVE_SEEDS Delete TopoPolygon and TopoLineString Items whose Link Items are all deleted by this operation.

SIS_CLEAN_TOPO_REMOVE_DANGLING, SIS_CLEAN_TOPO_FIX_UNDER_OVER and SIS_CLEAN_TOPO_REMOVE_SEEDS may be added together to perform several types of cleaning at once.

On completion the Named List will contain the topological Items which have been changed.

Remarks

Available: GEO OD SISpy

Group:

Example

sis.TopoClean ("CleanList", 1, SIS_CLEAN_TOPO_NONE)