Show / Hide Table of Contents

    Class ImmutableGpxWaypointTable

    An immutable list of GpxWaypoint instances.

    Inheritance
    Object
    ImmutableGpxWaypointTable
    Implements
    IReadOnlyList<GpxWaypoint>
    IReadOnlyCollection<GpxWaypoint>
    IEnumerable<GpxWaypoint>
    IEnumerable
    Inherited Members
    Object.Equals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Namespace: NetTopologySuite.IO
    Assembly: NetTopologySuite.IO.GPX.dll
    Syntax
    public sealed class ImmutableGpxWaypointTable : IReadOnlyList<GpxWaypoint>, IReadOnlyCollection<GpxWaypoint>, IEnumerable<GpxWaypoint>, IEnumerable
    Remarks

    Storage is optimized to minimize the cost of storing data members that are not actually used by any included waypoints. For example, if Links is empty on all included waypoints, then this table will not spend any memory on storing those empty lists.

    Constructors

    | Improve this Doc View Source

    ImmutableGpxWaypointTable(IEnumerable<GpxWaypoint>)

    Initializes a new instance of the ImmutableGpxWaypointTable class.

    Declaration
    public ImmutableGpxWaypointTable(IEnumerable<GpxWaypoint> waypoints)
    Parameters
    Type Name Description
    IEnumerable<GpxWaypoint> waypoints

    The GpxWaypoint instances to store.

    Exceptions
    Type Condition
    ArgumentNullException

    Thrown when waypoints is null.

    ArgumentException

    Thrown when an element of waypoints is null

    Fields

    | Improve this Doc View Source

    Empty

    An empty instance of ImmutableGpxWaypointTable.

    Declaration
    public static readonly ImmutableGpxWaypointTable Empty
    Field Value
    Type Description
    ImmutableGpxWaypointTable

    Properties

    | Improve this Doc View Source

    Count

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

    Item[Int32]

    Declaration
    public GpxWaypoint this[int index] { get; }
    Parameters
    Type Name Description
    Int32 index
    Property Value
    Type Description
    GpxWaypoint

    Methods

    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)
    | Improve this Doc View Source

    GetEnumerator()

    Declaration
    public ImmutableGpxWaypointTable.Enumerator GetEnumerator()
    Returns
    Type Description
    ImmutableGpxWaypointTable.Enumerator
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()
    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Object.ToString()

    Explicit Interface Implementations

    | Improve this Doc View Source

    IEnumerable<GpxWaypoint>.GetEnumerator()

    Declaration
    IEnumerator<GpxWaypoint> IEnumerable<GpxWaypoint>.GetEnumerator()
    Returns
    Type Description
    IEnumerator<GpxWaypoint>
    | Improve this Doc View Source

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    IEnumerator

    Implements

    System.Collections.Generic.IReadOnlyList<T>
    System.Collections.Generic.IReadOnlyCollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX