Class Depth

Namespace

NetTopologySuite.GeometriesGraph

Assembly

NetTopologySuite.dll

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

public class Depth

Inheritance

object

Depth

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Depth()

public Depth()

Properties

this[int, Positions]

Calls GetDepth and SetDepth.

[Obsolete("Use GetDepth, SetDepth")]
public int this[int geomIndex, Positions posIndex] { get; set; }

Parameters

geomIndex int

posIndex Positions

Property Value

int

Methods

Add(Label)

public void Add(Label lbl)

Parameters

lbl Label

Add(int, Positions, Location)

[Obsolete("This method is not used and will be removed in a later release.")]
public void Add(int geomIndex, Positions posIndex, Location _location)

Parameters

geomIndex int

posIndex Positions

_location Location

DepthAtLocation(Location)

public static int DepthAtLocation(Location _location)

Parameters

_location Location

Returns

int

GetDelta(int)

public int GetDelta(int geomIndex)

Parameters

geomIndex int

Returns

int

GetDepth(int, Position)

public int GetDepth(int geomIndex, Position posIndex)

Parameters

geomIndex int

posIndex Position

Returns

int

GetDepth(int, Positions)

[Obsolete("Use GetDepth(int, Geometries.Position)")]
public int GetDepth(int geomIndex, Positions posIndex)

Parameters

geomIndex int

posIndex Positions

Returns

int

GetLocation(int, Position)

public Location GetLocation(int geomIndex, Position posIndex)

Parameters

geomIndex int

posIndex Position

Returns

Location

GetLocation(int, Positions)

[Obsolete("Use GetLocation(int, Geometries.Position)")]
public Location GetLocation(int geomIndex, Positions posIndex)

Parameters

geomIndex int

posIndex Positions

Returns

Location

IsNull()

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

public bool IsNull()

Returns

bool

true if depth is null (has never been initialized)

IsNull(int)

public bool IsNull(int geomIndex)

Parameters

geomIndex int

Returns

bool

IsNull(int, Position)

public bool IsNull(int geomIndex, Position posIndex)

Parameters

geomIndex int

posIndex Position

Returns

bool

IsNull(int, Positions)

[Obsolete("Use IsNull(int, Geometries.Position)")]
public bool IsNull(int geomIndex, Positions posIndex)

Parameters

geomIndex int

posIndex Positions

Returns

bool

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.

public void Normalize()

SetDepth(int, Position, int)

public void SetDepth(int geomIndex, Position posIndex, int depthValue)

Parameters

geomIndex int

posIndex Position

depthValue int

SetDepth(int, Positions, int)

[Obsolete("Use SetDepth(int, Geometries.Position, int)")]
public void SetDepth(int geomIndex, Positions posIndex, int depthValue)

Parameters

geomIndex int

posIndex Positions

depthValue int

ToString()

public override string ToString()

Returns

string