Search Results for

    Show / Hide Table of Contents

    Class CoordinateSequenceFactory

    An object that knows how to build a particular implementation of CoordinateSequence from an array of Coordinates.

    Inheritance
    object
    CoordinateSequenceFactory
    CoordinateArraySequenceFactory
    DotSpatialAffineCoordinateSequenceFactory
    PackedCoordinateSequenceFactory
    RawCoordinateSequenceFactory
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: NetTopologySuite.Geometries
    Assembly: NetTopologySuite.dll
    Syntax
    [Serializable]
    public abstract class CoordinateSequenceFactory

    Constructors

    | Edit this page View Source

    CoordinateSequenceFactory()

    Initializes a new instance of the CoordinateSequenceFactory class.`

    Declaration
    protected CoordinateSequenceFactory()
    | Edit this page View Source

    CoordinateSequenceFactory(Ordinates)

    Initializes a new instance of the CoordinateSequenceFactory class.

    Declaration
    protected CoordinateSequenceFactory(Ordinates ordinates)
    Parameters
    Type Name Description
    Ordinates ordinates

    The maximum set of Ordinates flags that this instance will be able to create sequences for.

    Properties

    | Edit this page View Source

    Ordinates

    Gets the Ordinate flags that sequences created by this factory can maximal cope with.

    Declaration
    public Ordinates Ordinates { get; }
    Property Value
    Type Description
    Ordinates

    Methods

    | Edit this page View Source

    Create(CoordinateSequence)

    Creates a CoordinateSequence which is a copy of the given CoordinateSequence. This method must handle null arguments by creating an empty sequence.

    Declaration
    public virtual CoordinateSequence Create(CoordinateSequence coordSeq)
    Parameters
    Type Name Description
    CoordinateSequence coordSeq
    Returns
    Type Description
    CoordinateSequence

    A coordinate sequence

    | Edit this page View Source

    Create(Coordinate[])

    Returns a CoordinateSequence based on the given array; whether or not the array is copied is implementation-dependent.

    Declaration
    public virtual CoordinateSequence Create(Coordinate[] coordinates)
    Parameters
    Type Name Description
    Coordinate[] coordinates

    A coordinates array, which may not be null nor contain null elements

    Returns
    Type Description
    CoordinateSequence

    A coordinate sequence.

    | Edit this page View Source

    Create(int, Ordinates)

    Creates a CoordinateSequence of the specified size and ordinates. For this to be useful, the CoordinateSequence implementation must be mutable.

    Declaration
    public virtual CoordinateSequence Create(int size, Ordinates ordinates)
    Parameters
    Type Name Description
    int size

    The number of coordinates.

    Ordinates ordinates

    The ordinates each coordinate has. XY is fix, Z and M can be set.

    Returns
    Type Description
    CoordinateSequence

    A coordinate sequence.

    | Edit this page View Source

    Create(int, int)

    Creates a CoordinateSequence of the specified size and dimension. For this to be useful, the CoordinateSequence implementation must be mutable.

    Declaration
    [Obsolete("Use an overload that accepts measures.  This overload will be removed in a future release.")]
    public CoordinateSequence Create(int size, int dimension)
    Parameters
    Type Name Description
    int size
    int dimension

    the dimension of the coordinates in the sequence (if user-specifiable, otherwise ignored)

    Returns
    Type Description
    CoordinateSequence

    A coordinate sequence

    Remarks

    If the requested dimension is larger than the CoordinateSequence implementation can provide, then a sequence of maximum possible dimension should be created. An error should not be thrown.

    | Edit this page View Source

    Create(int, int, int)

    Creates a CoordinateSequence of the specified size and dimension with measure support. For this to be useful, the CoordinateSequence implementation must be mutable.

    Declaration
    public abstract CoordinateSequence Create(int size, int dimension, int measures)
    Parameters
    Type Name Description
    int size

    The number of coordinates in the sequence

    int dimension

    The dimension of the coordinates in the sequence (if user-specifiable, otherwise ignored)

    int measures

    The number of measures of the coordinates in the sequence (if user-specifiable, otherwise ignored)

    Returns
    Type Description
    CoordinateSequence
    Remarks

    If the requested dimension or measures are larger than the CoordinateSequence implementation can provide, then a sequence of maximum possible dimension should be created. An error should not be thrown.

    | Edit this page View Source

    GetCommonSequenceParameters(Coordinate[])

    Gets the three parameters needed to create any CoordinateSequence instance (Count, Dimension, and Measures) such that the sequence can store all the data from a given array of Coordinate instances.

    Declaration
    public static (int Count, int Dimension, int Measures) GetCommonSequenceParameters(Coordinate[] coordinates)
    Parameters
    Type Name Description
    Coordinate[] coordinates

    The array of Coordinate instances that the sequence will be created from.

    Returns
    Type Description
    (int Count, int Dimension, int Measures)

    The values of the three parameters to use for creating the sequence.

    See Also

    CoordinateSequence
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX