NetTopologySuite
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
NetTopologySuite.GeometriesGraph.Depth Class Reference

A Depth object records the topological depth of the sides of an Edge for up to two Geometries. More...

Public Member Functions

 Depth ()
 
int GetDepth (int geomIndex, Positions posIndex)
 
void SetDepth (int geomIndex, Positions posIndex, int depthValue)
 
Location GetLocation (int geomIndex, Positions posIndex)
 
void Add (int geomIndex, Positions posIndex, Location _location)
 
bool IsNull ()
 A Depth object is null (has never been initialized) if all depths are null. More...
 
bool IsNull (int geomIndex)
 
bool IsNull (int geomIndex, Positions posIndex)
 
void Add (Label lbl)
 
int GetDelta (int geomIndex)
 
void Normalize ()
 Normalize the depths for each point, if they are non-null. A normalized depth has depth values in the set { 0, 1 }. Normalizing the depths involves reducing the depths by the same amount so that at least one of them is 0. If the remaining value is > 0, it is set to 1. More...
 
override string ToString ()
 

Static Public Member Functions

static int DepthAtLocation (Location _location)
 

Properties

int this[int geomIndex, Positions posIndex] [get, set]
 Calls GetDepth and SetDepth. More...
 

Detailed Description

A Depth object records the topological depth of the sides of an Edge for up to two Geometries.

Constructor & Destructor Documentation

NetTopologySuite.GeometriesGraph.Depth.Depth ( )

Member Function Documentation

void NetTopologySuite.GeometriesGraph.Depth.Add ( int  geomIndex,
Positions  posIndex,
Location  _location 
)

Parameters
geomIndex
posIndex
_location
void NetTopologySuite.GeometriesGraph.Depth.Add ( Label  lbl)

Parameters
lbl
static int NetTopologySuite.GeometriesGraph.Depth.DepthAtLocation ( Location  _location)
static

Parameters
_location
Returns
int NetTopologySuite.GeometriesGraph.Depth.GetDelta ( int  geomIndex)

Parameters
geomIndex
Returns
int NetTopologySuite.GeometriesGraph.Depth.GetDepth ( int  geomIndex,
Positions  posIndex 
)

Parameters
geomIndex
posIndex
Returns
Location NetTopologySuite.GeometriesGraph.Depth.GetLocation ( int  geomIndex,
Positions  posIndex 
)

Parameters
geomIndex
posIndex
Returns
bool NetTopologySuite.GeometriesGraph.Depth.IsNull ( )

A Depth object is null (has never been initialized) if all depths are null.

bool NetTopologySuite.GeometriesGraph.Depth.IsNull ( int  geomIndex)

Parameters
geomIndex
Returns
bool NetTopologySuite.GeometriesGraph.Depth.IsNull ( int  geomIndex,
Positions  posIndex 
)

Parameters
geomIndex
posIndex
Returns
void NetTopologySuite.GeometriesGraph.Depth.Normalize ( )

Normalize the depths for each point, if they are non-null. A normalized depth has depth values in the set { 0, 1 }. Normalizing the depths involves reducing the depths by the same amount so that at least one of them is 0. If the remaining value is > 0, it is set to 1.

void NetTopologySuite.GeometriesGraph.Depth.SetDepth ( int  geomIndex,
Positions  posIndex,
int  depthValue 
)

Parameters
geomIndex
posIndex
depthValue
override string NetTopologySuite.GeometriesGraph.Depth.ToString ( )

Returns

Property Documentation

int NetTopologySuite.GeometriesGraph.Depth.this[int geomIndex, Positions posIndex]
getset

Calls GetDepth and SetDepth.

Parameters
geomIndex
posIndex
Returns

The documentation for this class was generated from the following file: