Class CoordinateZ

A lightweight class used to store coordinates on the 2-dimensional Cartesian plane and an additional z-ordinate (Z) value.

This base data object is suitable for use with coordinate sequences with dimension = 3 and measures = 0.

Inheritance

Object

Coordinate

CoordinateZ

CoordinateZM

Implements

IComparable

IComparable<Coordinate>

Inherited Members

Coordinate.NullOrdinate

Coordinate.X

Coordinate.Y

Coordinate.M

Coordinate.Item[Ordinate]

Coordinate.IsValid

Coordinate.Equals2D(Coordinate)

Coordinate.Equals2D(Coordinate, Double)

Coordinate.EqualsWithTolerance(Double, Double, Double)

Coordinate.Equals(Coordinate)

Coordinate.CompareTo(Object)

Coordinate.CompareTo(Coordinate)

Coordinate.Copy()

Coordinate.Distance(Coordinate)

Coordinate.Equals(Object)

Coordinate.GetHashCode()

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: NetTopologySuite.Geometries

Assembly: NetTopologySuite.dll

Syntax

[Serializable]
public class CoordinateZ : Coordinate, IComparable, IComparable<Coordinate>

Remarks

It is distinct from Point, which is a subclass of Geometry. Unlike objects of type Point (which contain additional information such as an envelope, a precision model, and spatial reference system information), a CoordinateZ only contains ordinate values and properties.

CoordinateZs are two-dimensional points, with an additional Z-ordinate. If an Z-ordinate value is not specified or not defined, constructed coordinates have a Z-ordinate of NaN (which is also the value of NullOrdinate).

Apart from the basic accessor functions, NTS supports only specific operations involving the Z-ordinate.

Implementations may optionally support Z-ordinate and M-measure values as appropriate for a CoordinateSequence. Use of Z and M setters or NetTopologySuite.Geometries.CoordinateZ.this[int] indexer are recommended.

Constructors

CoordinateZ()

Constructs a CoordinateZ at (0,0,NaN).

Declaration

public CoordinateZ()

CoordinateZ(Coordinate)

Constructs a CoordinateZ having the same (x,y) values as c.

Declaration

public CoordinateZ(Coordinate c)

Parameters

Type	Name	Description
Coordinate	c	Coordinate to copy.

CoordinateZ(Double, Double)

Constructs a CoordinateZ at (x,y,NaN).

Declaration

public CoordinateZ(double x, double y)

Parameters

Type	Name	Description
Double	x	X value.
Double	y	Y value.

CoordinateZ(Double, Double, Double)

Constructs a CoordinateZ at (x,y,z).

Declaration

public CoordinateZ(double x, double y, double z)

Parameters

Type	Name	Description
Double	x	The X value
Double	y	The Y value
Double	z	The Z value

Properties

CoordinateValue

Gets/Sets CoordinateZs (x,y,z) values.

Declaration

public override Coordinate CoordinateValue { get; set; }

Property Value

Type	Description
Coordinate

Overrides

Coordinate.CoordinateValue

Item[Int32]

Gets or sets the ordinate value for the given index.

Declaration

public override double this[int ordinateIndex] { get; set; }

Parameters

Type	Name	Description
Int32	ordinateIndex	The ordinate index

Property Value

Type	Description
Double	The ordinate value

Overrides

Coordinate.Item[Int32]

Remarks

The base implementation supports 0 (X), 1 (Y) and 2 (Z) as values for the index.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown if ordinateIndex is not in the valid range.

Z

Gets or sets the Z-ordinate value.

Declaration

public sealed override double Z { get; set; }

Property Value

Type	Description
Double

Overrides

Coordinate.Z

Methods

Create(Double, Double, Double, Double)

Create a Coordinate of the same type as this Coordinate, using the provided values for x, y and z.

Declaration

public override Coordinate Create(double x = 0, double y = 0, double z = NaN, double m = NaN)

Parameters

Type	Name	Description
Double	x	The x-ordinate value, if not provided, it is 0d.
Double	y	The y-ordinate value, if not provided, it is 0d.
Double	z	The z-ordinate value, if not provided, it is NullOrdinate.
Double	m	The m-ordinate value, if not provided, it is NullOrdinate.

Returns

Type	Description
Coordinate	A new CoordinateZ

Overrides

Coordinate.Create(Double, Double, Double, Double)

Remarks

A provided value for m will be silently dropped.

Distance3D(CoordinateZ)

Computes the 3-dimensional Euclidean distance to another location.

Declaration

public double Distance3D(CoordinateZ c)

Parameters

Type	Name	Description
CoordinateZ	c	A CoordinateZ with which to do the distance comparison.

Returns

Type	Description
Double	the 3-dimensional Euclidean distance between the locations.

EqualInZ(CoordinateZ, Double)

Tests if another CoordinateZ has the same value for Z, within a tolerance.

Declaration

public bool EqualInZ(CoordinateZ c, double tolerance)

Parameters

Type	Name	Description
CoordinateZ	c	A CoordinateZ.
Double	tolerance	The tolerance value.

Returns

Type	Description
Boolean	true if the Z ordinates are within the given tolerance.

Equals3D(CoordinateZ)

Returns true if other has the same values for X, Y and Z.

Declaration

public bool Equals3D(CoordinateZ other)

Parameters

Type	Name	Description
CoordinateZ	other	A CoordinateZ with which to do the 3D comparison.

Returns

Type	Description
Boolean	true if other is a CoordinateZ with the same values for X, Y and Z.

ToString()

Returns a string of the form (x, y, z) .

Declaration

public override string ToString()

Returns

Type	Description
String	string of the form (x, y, z)

Overrides

Coordinate.ToString()

Implements

System.IComparable

System.IComparable<T>