Class LineString

Models an OGC-style LineString

Inheritance

object

Geometry

LineString

LinearRing

Implements

IComparable

IComparable<Geometry>

ILineal

Inherited Members

Geometry.TypeNamePoint

Geometry.TypeNameMultiPoint

Geometry.TypeNameLineString

Geometry.TypeNameLinearRing

Geometry.TypeNameMultiLineString

Geometry.TypeNamePolygon

Geometry.TypeNameMultiPolygon

Geometry.TypeNameGeometryCollection

Geometry.Factory

Geometry.UserData

Geometry.SRID

Geometry.HasNonEmptyElements(Geometry[])

Geometry.HasNullElements(object[])

Geometry.HasNullElements<T>(IEnumerable<T>)

Geometry.PrecisionModel

Geometry.NumGeometries

Geometry.GetGeometryN(int)

Geometry.IsSimple

Geometry.IsValid

Geometry.Distance(Geometry)

Geometry.IsWithinDistance(Geometry, double)

Geometry.Area

Geometry.Centroid

Geometry.InteriorPoint

Geometry.PointOnSurface

Geometry.HasDimension(Dimension)

Geometry.Envelope

Geometry.EnvelopeInternal

Geometry.GeometryChanged()

Geometry.GeometryChangedAction()

Geometry.Disjoint(Geometry)

Geometry.Touches(Geometry)

Geometry.Intersects(Geometry)

Geometry.Crosses(Geometry)

Geometry.Within(Geometry)

Geometry.Contains(Geometry)

Geometry.Overlaps(Geometry)

Geometry.Covers(Geometry)

Geometry.CoveredBy(Geometry)

Geometry.Relate(Geometry, string)

Geometry.Relate(Geometry)

Geometry.Equals(Geometry)

Geometry.EqualsTopologically(Geometry)

Geometry.Equals(object)

Geometry.GetHashCode()

Geometry.ToString()

Geometry.ToText()

Geometry.AsText()

Geometry.ToBinary()

Geometry.AsBinary()

Geometry.ToGMLFeature()

Geometry.Buffer(double)

Geometry.Buffer(double, EndCapStyle)

Geometry.Buffer(double, int)

Geometry.Buffer(double, int, EndCapStyle)

Geometry.Buffer(double, BufferParameters)

Geometry.ConvexHull()

Geometry.Intersection(Geometry)

Geometry.Union(Geometry)

Geometry.Difference(Geometry)

Geometry.SymmetricDifference(Geometry)

Geometry.Union()

Geometry.EqualsExact(Geometry)

Geometry.EqualsNormalized(Geometry)

Geometry.Copy()

Geometry.Normalized()

Geometry.CompareTo(object)

Geometry.CompareTo(Geometry)

Geometry.CompareTo(object, IComparer<CoordinateSequence>)

Geometry.CheckNotGeometryCollection(Geometry)

Geometry.IsGeometryCollection

Geometry.Compare(List<Geometry>, List<Geometry>)

Geometry.Equal(Coordinate, Coordinate, double)

Geometry.IsRectangle

Geometry.DefaultFactory

Geometry.CreateArray(int, double)

Geometry.CreateArray(CoordinateSequence, Ordinate)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: NetTopologySuite.Geometries

Assembly: NetTopologySuite.dll

Syntax

[Serializable]
public class LineString : Geometry, IComparable, IComparable<Geometry>, ILineal

Remarks

A LineString consists of a sequence of two or more vertices, along with all points along the linearly-interpolated curves (line segments) between each pair of consecutive vertices. Consecutive vertices may be equal. The line segments in the line may intersect each other (in other words, the LineString may "curl back" in itself and self-intersect. LineStrings with exactly two identical points are invalid.

A LineString must have either 0 or MinimumValidSize or more points. If these conditions are not met, the constructors throw an ArgumentException.

Constructors

LineString(CoordinateSequence, GeometryFactory)

Initializes a new instance of the LineString class.

Declaration

public LineString(CoordinateSequence points, GeometryFactory factory)

Parameters

Type	Name	Description
CoordinateSequence	points	The points of the LineString, or null to create the empty point. Consecutive points may not be equal.
GeometryFactory	factory

Exceptions

Type	Condition
ArgumentException	If too few points are provided

LineString(Coordinate[])

Initializes a new instance of the LineString class.

Declaration

public LineString(Coordinate[] points)

Parameters

Type	Name	Description
Coordinate[]	points	The coordinates used for create this LineString.

Remarks

For create this Geometry is used a standard GeometryFactory with PrecisionModel == Floating.

Exceptions

Type	Condition
ArgumentException	If too few points are provided

Fields

Empty

Represents an empty LineString.

Declaration

public static readonly LineString Empty

Field Value

Type	Description
LineString

MinimumValidSize

The minimum number of vertices allowed in a valid non-empty linestring. Empty linestrings with 0 vertices are also valid.

Declaration

public const int MinimumValidSize = 2

Field Value

Type	Description
int

Properties

Boundary

Returns the boundary, or an empty geometry of appropriate dimension if this Geometry is empty. For a discussion of this function, see the OpenGIS Simple Features Specification. As stated in SFS Section 2.1.13.1, "the boundary of a Geometry is a set of Geometries of the next lower dimension."

Declaration

public override Geometry Boundary { get; }

Property Value

Type	Description
Geometry	The closure of the combinatorial boundary of this Geometry.

Overrides

Geometry.Boundary

BoundaryDimension

Declaration

public override Dimension BoundaryDimension { get; }

Property Value

Type	Description
Dimension

Overrides

Geometry.BoundaryDimension

Coordinate

Declaration

public override Coordinate Coordinate { get; }

Property Value

Type	Description
Coordinate

Overrides

Geometry.Coordinate

CoordinateSequence

Declaration

public CoordinateSequence CoordinateSequence { get; }

Property Value

Type	Description
CoordinateSequence

Coordinates

Returns an array containing the values of all the vertices for this geometry.

Declaration

public override Coordinate[] Coordinates { get; }

Property Value

Type	Description
Coordinate[]	The vertices of this Geometry.

Overrides

Geometry.Coordinates

Remarks

If the geometry is a composite, the array will contain all the vertices for the components, in the order in which the components occur in the geometry.

In general, the array cannot be assumed to be the actual internal storage for the vertices. Thus modifying the array may not modify the geometry itself. Use the SetOrdinate(int, int, double) method (possibly on the components) to modify the underlying data. If the coordinates are modified, GeometryChanged() must be called afterwards.

See Also

GeometryChanged()

SetOrdinate(int, int, double)

SetOrdinate(int, Ordinate, double)

Count

Declaration

public int Count { get; }

Property Value

Type	Description
int

Dimension

Declaration

public override Dimension Dimension { get; }

Property Value

Type	Description
Dimension

Overrides

Geometry.Dimension

EndPoint

Gets a value indicating the end point of this LINESTRING

Declaration

public Point EndPoint { get; }

Property Value

Type	Description
Point

GeometryType

Returns the name of this object's interface.

Declaration

public override string GeometryType { get; }

Property Value

Type	Description
string	"LineString"

Overrides

Geometry.GeometryType

IsClosed

Gets a value indicating if this LINESTRING is closed.

Declaration

public virtual bool IsClosed { get; }

Property Value

Type	Description
bool

IsEmpty

Declaration

public override bool IsEmpty { get; }

Property Value

Type	Description
bool

Overrides

Geometry.IsEmpty

IsRing

Gets a value indicating if this LINESTRING forms a ring.

Declaration

public bool IsRing { get; }

Property Value

Type	Description
bool

this[int]

Declaration

public Coordinate this[int n] { get; set; }

Parameters

Type	Name	Description
int	n

Property Value

Type	Description
Coordinate

Length

Returns the length of this LineString

Declaration

public override double Length { get; }

Property Value

Type	Description
double	The length of the polygon.

Overrides

Geometry.Length

NumPoints

Declaration

public override int NumPoints { get; }

Property Value

Type	Description
int

Overrides

Geometry.NumPoints

OgcGeometryType

Gets the OGC geometry type

Declaration

public override OgcGeometryType OgcGeometryType { get; }

Property Value

Type	Description
OgcGeometryType

Overrides

Geometry.OgcGeometryType

SortIndex

Gets a value to sort the geometry

Declaration

protected override Geometry.SortIndexValue SortIndex { get; }

Property Value

Type	Description
Geometry.SortIndexValue

Overrides

Geometry.SortIndex

Remarks

NOTE:
For JTS v1.17 this property's getter has been renamed to getTypeCode(). In order not to break binary compatibility we did not follow.

StartPoint

Gets a value indicating the start point of this LINESTRING

Declaration

public Point StartPoint { get; }

Property Value

Type	Description
Point

Methods

Apply(ICoordinateFilter)

Declaration

public override void Apply(ICoordinateFilter filter)

Parameters

Type	Name	Description
ICoordinateFilter	filter

Overrides

Geometry.Apply(ICoordinateFilter)

Apply(ICoordinateSequenceFilter)

Performs an operation on the coordinates in this Geometry's CoordinateSequences.

Declaration

public override void Apply(ICoordinateSequenceFilter filter)

Parameters

Type	Name	Description
ICoordinateSequenceFilter	filter	The filter to apply

Overrides

Geometry.Apply(ICoordinateSequenceFilter)

Remarks

If the filter reports that a coordinate value has been changed, GeometryChanged() will be called automatically.

Apply(IEntireCoordinateSequenceFilter)

Performs an operation on this Geometry's CoordinateSequences.

Declaration

public override void Apply(IEntireCoordinateSequenceFilter filter)

Parameters

Type	Name	Description
IEntireCoordinateSequenceFilter	filter	The filter to apply

Overrides

Geometry.Apply(IEntireCoordinateSequenceFilter)

Remarks

If the filter reports that a coordinate value has been changed, GeometryChanged() will be called automatically.

Apply(IGeometryComponentFilter)

Performs an operation with or on this Geometry and its component Geometry's. Only GeometryCollections and Polygons have component Geometry's; for Polygons they are the LinearRings of the shell and holes.

Declaration

public override void Apply(IGeometryComponentFilter filter)

Parameters

Type	Name	Description
IGeometryComponentFilter	filter	The filter to apply to this Geometry.

Overrides

Geometry.Apply(IGeometryComponentFilter)

Apply(IGeometryFilter)

Performs an operation with or on this Geometry and its subelement Geometrys (if any). Only GeometryCollections and subclasses have subelement Geometry's.

Declaration

public override void Apply(IGeometryFilter filter)

Parameters

Type	Name	Description
IGeometryFilter	filter	The filter to apply to this Geometry (and its children, if it is a GeometryCollection).

Overrides

Geometry.Apply(IGeometryFilter)

CompareToSameClass(object)

Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.

Declaration

protected override int CompareToSameClass(object o)

Parameters

Type	Name	Description
object	o	A Geometry having the same class as this Geometry.

Returns

Type	Description
int	A positive number, 0, or a negative number, depending on whether this object is greater than, equal to, or less than o, as defined in "Normal Form For Geometry" in the NTS Technical Specifications.

Overrides

Geometry.CompareToSameClass(object)

CompareToSameClass(object, IComparer<CoordinateSequence>)

Returns whether this Geometry is greater than, equal to, or less than another Geometry of the same class. using the given IComparer<T>.

Declaration

protected override int CompareToSameClass(object o, IComparer<CoordinateSequence> comp)

Parameters

Type	Name	Description
object	o	A Geometry having the same class as this Geometry
IComparer<CoordinateSequence>	comp	The comparer

Returns

Type	Description
int	A positive number, 0, or a negative number, depending on whether this object is greater than, equal to, or less than o, as defined in "Normal Form For Geometry" in the JTS Technical Specifications

Overrides

Geometry.CompareToSameClass(object, IComparer<CoordinateSequence>)

ComputeEnvelopeInternal()

Declaration

protected override Envelope ComputeEnvelopeInternal()

Returns

Type	Description
Envelope

Overrides

Geometry.ComputeEnvelopeInternal()

CopyInternal()

An internal method to copy subclass-specific geometry data.

Declaration

protected override Geometry CopyInternal()

Returns

Type	Description
Geometry	A copy of the target geometry object.

Overrides

Geometry.CopyInternal()

EqualsExact(Geometry, double)

Declaration

public override bool EqualsExact(Geometry other, double tolerance)

Parameters

Type	Name	Description
Geometry	other
double	tolerance

Returns

Type	Description
bool

Overrides

Geometry.EqualsExact(Geometry, double)

GetCoordinateN(int)

Declaration

public Coordinate GetCoordinateN(int n)

Parameters

Type	Name	Description
int	n

Returns

Type	Description
Coordinate

GetOrdinates(Ordinate)

Gets an array of double ordinate values

Declaration

public override double[] GetOrdinates(Ordinate ordinate)

Parameters

Type	Name	Description
Ordinate	ordinate	The ordinate index

Returns

Type	Description
double[]	An array of ordinate values

Overrides

Geometry.GetOrdinates(Ordinate)

GetPointN(int)

Gets

Declaration

public Point GetPointN(int n)

Parameters

Type	Name	Description
int	n

Returns

Type	Description
Point

IsCoordinate(Coordinate)

Returns true if the given point is a vertex of this LineString.

Declaration

public virtual bool IsCoordinate(Coordinate pt)

Parameters

Type	Name	Description
Coordinate	pt	The Coordinate to check.

Returns

Type	Description
bool	true if pt is one of this LineString's vertices.

IsEquivalentClass(Geometry)

Returns whether the two Geometrys are equal, from the point of view of the EqualsExact method. Called by EqualsExact . In general, two Geometry classes are considered to be "equivalent" only if they are the same class. An exception is LineString , which is considered to be equivalent to its subclasses.

Declaration

protected override bool IsEquivalentClass(Geometry other)

Parameters

Type	Name	Description
Geometry	other	The Geometry with which to compare this Geometry for equality.

Returns

Type	Description
bool	true if the classes of the two Geometry s are considered to be equal by the equalsExact method.

Overrides

Geometry.IsEquivalentClass(Geometry)

Normalize()

Normalizes a LineString. A normalized LineString has the first point which is not equal to it's reflected point less than the reflected point.

Declaration

public override void Normalize()

Overrides

Geometry.Normalize()

Reverse()

Creates a LineString whose coordinates are in the reverse order of this objects.

Declaration

[Obsolete("Call Geometry.Reverse()")]
public override Geometry Reverse()

Returns

Type	Description
Geometry	A LineString with coordinates in the reverse order.

Overrides

Geometry.Reverse()

ReverseInternal()

The actual implementation of the Reverse() function for LINESTRINGs.

Declaration

protected override Geometry ReverseInternal()

Returns

Type	Description
Geometry	A reversed geometry

Overrides

Geometry.ReverseInternal()

Implements

IComparable

IComparable<T>

ILineal

Extension Methods

PolygonalExtracter.GetPolygonals<TCollection>(Geometry)

PolygonalExtracter.GetPolygonals<TCollection>(Geometry, TCollection)