Class LineString

Models an OGC-style LineString

Inheritance
Object
Geometry
LineString
LinearRing
Inherited Members
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

| Improve this Doc View Source

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
| Improve this Doc View Source

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

Fields

| Improve this Doc View Source

Empty

Represents an empty LineString.

Declaration
public static readonly LineString Empty
Field Value
Type Description
LineString
| Improve this Doc View Source

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
Int32

Properties

| Improve this Doc View Source

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
| Improve this Doc View Source

BoundaryDimension

Declaration
public override Dimension BoundaryDimension { get; }
Property Value
Type Description
Dimension
Overrides
| Improve this Doc View Source

Coordinate

Declaration
public override Coordinate Coordinate { get; }
Property Value
Type Description
Coordinate
Overrides
| Improve this Doc View Source

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
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(Int32, Int32, Double) method (possibly on the components) to modify the underlying data. If the coordinates are modified, GeometryChanged() must be called afterwards.

See Also
| Improve this Doc View Source

CoordinateSequence

Declaration
public CoordinateSequence CoordinateSequence { get; }
Property Value
Type Description
CoordinateSequence
| Improve this Doc View Source

Count

Declaration
public int Count { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Dimension

Declaration
public override Dimension Dimension { get; }
Property Value
Type Description
Dimension
Overrides
| Improve this Doc View Source

EndPoint

Gets a value indicating the end point of this LINESTRING

Declaration
public Point EndPoint { get; }
Property Value
Type Description
Point
| Improve this Doc View Source

GeometryType

Returns the name of this object's interface.

Declaration
public override string GeometryType { get; }
Property Value
Type Description
String

"LineString"
Overrides
| Improve this Doc View Source

IsClosed

Gets a value indicating if this LINESTRING is closed.

Declaration
public virtual bool IsClosed { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsEmpty

Declaration
public override bool IsEmpty { get; }
Property Value
Type Description
Boolean
Overrides
| Improve this Doc View Source

IsRing

Gets a value indicating if this LINESTRING forms a ring.

Declaration
public bool IsRing { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Item[Int32]

Declaration
public Coordinate this[int n] { get; set; }
Parameters
Type Name Description
Int32 n
Property Value
Type Description
Coordinate
| Improve this Doc View Source

Length

Returns the length of this LineString

Declaration
public override double Length { get; }
Property Value
Type Description
Double

The length of the polygon.
Overrides
| Improve this Doc View Source

NumPoints

Declaration
public override int NumPoints { get; }
Property Value
Type Description
Int32
Overrides
| Improve this Doc View Source

OgcGeometryType

Gets the OGC geometry type

Declaration
public override OgcGeometryType OgcGeometryType { get; }
Property Value
Type Description
OgcGeometryType
Overrides
| Improve this Doc View Source

SortIndex

Gets a value to sort the geometry

Declaration
protected override Geometry.SortIndexValue SortIndex { get; }
Property Value
Type Description
Geometry.SortIndexValue
Overrides
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.

| Improve this Doc View Source

StartPoint

Gets a value indicating the start point of this LINESTRING

Declaration
public Point StartPoint { get; }
Property Value
Type Description
Point

Methods

| Improve this Doc View Source

Apply(ICoordinateFilter)

Declaration
public override void Apply(ICoordinateFilter filter)
Parameters
Type Name Description
ICoordinateFilter filter
Overrides
| Improve this Doc View Source

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
Remarks

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

| Improve this Doc View Source

Apply(IEntireCoordinateSequenceFilter)

Declaration
public override void Apply(IEntireCoordinateSequenceFilter filter)
Parameters
Type Name Description
IEntireCoordinateSequenceFilter filter
Overrides
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

CompareToSameClass(Object)

Declaration
protected override int CompareToSameClass(object o)
Parameters
Type Name Description
Object o
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

CompareToSameClass(Object, IComparer<CoordinateSequence>)

Declaration
protected override int CompareToSameClass(object o, IComparer<CoordinateSequence> comp)
Parameters
Type Name Description
Object o
IComparer<CoordinateSequence> comp
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

ComputeEnvelopeInternal()

Declaration
protected override Envelope ComputeEnvelopeInternal()
Returns
Type Description
Envelope
Overrides
| Improve this Doc View Source

CopyInternal()

Declaration
protected override Geometry CopyInternal()
Returns
Type Description
Geometry
Overrides
| Improve this Doc View Source

EqualsExact(Geometry, Double)

Declaration
public override bool EqualsExact(Geometry other, double tolerance)
Parameters
Type Name Description
Geometry other
Double tolerance
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetCoordinateN(Int32)

Declaration
public Coordinate GetCoordinateN(int n)
Parameters
Type Name Description
Int32 n
Returns
Type Description
Coordinate
| Improve this Doc View Source

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
| Improve this Doc View Source

GetPointN(Int32)

Gets

Declaration
public Point GetPointN(int n)
Parameters
Type Name Description
Int32 n
Returns
Type Description
Point
| Improve this Doc View Source

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
Boolean

true if pt is one of this LineString's vertices.
| Improve this Doc View Source

IsEquivalentClass(Geometry)

Declaration
protected override bool IsEquivalentClass(Geometry other)
Parameters
Type Name Description
Geometry other
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

ReverseInternal()

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

Declaration
protected override Geometry ReverseInternal()
Returns
Type Description
Geometry

A reversed geometry
Overrides

Implements