CoordinateList Class |
Inheritance HierarchySystem.Collections.GenericListICoordinate
DHI.Mike1D.Generic.Spatial.GeometryCoordinateList
Namespace: DHI.Mike1D.Generic.Spatial.Geometry
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 16.0.0.0 (11.1.1.1111)
Syntax[SerializableAttribute] public class CoordinateList : List<ICoordinate>, ICoordinateSequence, IList<ICoordinate>, ICollection<ICoordinate>, IEnumerable<ICoordinate>, IEnumerable
The CoordinateList type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Capacity | Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from ListICoordinate.) |
| CoordinateType |
Type of coordinate. All coordinates in the sequence must be of the same type
|
| Count | Gets the number of elements actually contained in the ListT. (Inherited from ListICoordinate.) |
| Item | Gets or sets the element at the specified index. (Inherited from ListICoordinate.) |
| SortByM |
If true, keeps data sorted by their M value
|
Methods| Name | Description | |
|---|---|---|
 | Add |
Add a ICoordinate to the list
|
| AddRange | Adds the elements of the specified collection to the end of the ListT. (Inherited from ListICoordinate.) |
| AsReadOnly | Returns a read-only IListT wrapper for the current collection. (Inherited from ListICoordinate.) |
| BinarySearch(T) | Searches the entire sorted ListT for an element using the default comparer and returns the zero-based index of the element. (Inherited from ListICoordinate.) |
| BinarySearch(T, IComparerT) | Searches the entire sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListICoordinate.) |
| BinarySearch(Int32, Int32, T, IComparerT) | Searches a range of elements in the sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListICoordinate.) |
| Clear | Removes all elements from the ListT. (Inherited from ListICoordinate.) |
| Contains | Determines whether an element is in the ListT. (Inherited from ListICoordinate.) |
| ConvertAllTOutput | Converts the elements in the current ListT to another type, and returns a list containing the converted elements. (Inherited from ListICoordinate.) |
| CopyTo(T) | Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from ListICoordinate.) |
| CopyTo(T, Int32) | Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListICoordinate.) |
| CopyTo(Int32, T, Int32, Int32) | Copies a range of elements from the ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListICoordinate.) |
 | Create(CoordinateType) |
Create a coordinate list of the specified type
|
| Create(CoordinateType, IEnumerableICoordinate) |
Creates a new CoordinateList of the specified type that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied.
|
| Create(CoordinateType, Int32) |
Create a coordinate list of the specified type and with the specified initial capacity
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists | Determines whether the ListT contains elements that match the conditions defined by the specified predicate. (Inherited from ListICoordinate.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Find | Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| FindAll | Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from ListICoordinate.) |
| FindIndex(PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| FindIndex(Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListICoordinate.) |
| FindIndex(Int32, Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListICoordinate.) |
| FindLast | Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| FindLastIndex(PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| FindLastIndex(Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListICoordinate.) |
| FindLastIndex(Int32, Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListICoordinate.) |
| ForEach | Performs the specified action on each element of the ListT. (Inherited from ListICoordinate.) |
| GetEnumerator | Returns an enumerator that iterates through the ListT. (Inherited from ListICoordinate.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRange | Creates a shallow copy of a range of elements in the source ListT. (Inherited from ListICoordinate.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf(T) | Searches for the specified object and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| IndexOf(T, Int32) | Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListICoordinate.) |
| IndexOf(T, Int32, Int32) | Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListICoordinate.) |
| Insert | Inserts an element into the ListT at the specified index. (Inherited from ListICoordinate.) |
| InsertRange | Inserts the elements of a collection into the ListT at the specified index. (Inherited from ListICoordinate.) |
| LastIndexOf(T) | Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListICoordinate.) |
| LastIndexOf(T, Int32) | Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListICoordinate.) |
| LastIndexOf(T, Int32, Int32) | Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListICoordinate.) |
| LocateAlong(Double) |
Returns a derived ICoordinate value that matches the specified m coordinate value.
If the specified m-coordinate is outside the span of m-values in the sequence, null
is returned.
|
| LocateAlong(Double, Boolean) |
Returns a derived ICoordinate value that matches the specified m coordinate value
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Remove | Removes the first occurrence of a specific object from the ListT. (Inherited from ListICoordinate.) |
| RemoveAll | Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ListICoordinate.) |
| RemoveAt | Removes the element at the specified index of the ListT. (Inherited from ListICoordinate.) |
| RemoveRange | Removes a range of elements from the ListT. (Inherited from ListICoordinate.) |
| Reverse | Reverses the order of the elements in the entire ListT. (Inherited from ListICoordinate.) |
| Reverse(Int32, Int32) | Reverses the order of the elements in the specified range. (Inherited from ListICoordinate.) |
| SetSortByM |
Set the flag to sort coordinate list on chainage
|
| Sort | Sorts the elements in the entire ListT using the default comparer. (Inherited from ListICoordinate.) |
| Sort(IComparerT) | Sorts the elements in the entire ListT using the specified comparer. (Inherited from ListICoordinate.) |
| Sort(ComparisonT) | Sorts the elements in the entire ListT using the specified ComparisonT. (Inherited from ListICoordinate.) |
| Sort(Int32, Int32, IComparerT) | Sorts the elements in a range of elements in ListT using the specified comparer. (Inherited from ListICoordinate.) |
| ToArray | Copies the elements of the ListT to a new array. (Inherited from ListICoordinate.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TrimExcess | Sets the capacity to the actual number of elements in the ListT, if that number is less than a threshold value. (Inherited from ListICoordinate.) |
| TrueForAll | Determines whether every element in the ListT matches the conditions defined by the specified predicate. (Inherited from ListICoordinate.) |
Extension Methods| Name | Description | |
|---|---|---|
 | BinarySearchICoordinate(ICoordinate) | Overloaded.
Searches the entire sorted IListT for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval] |
 | BinarySearchICoordinate(FuncICoordinate, Int32) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)This differs from the "ordinary" binary search in allowing a comparer delegate that defines whether an item is found (returning 0), whether the item in the list is before (<0) or after (>0) that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. Examples
If having a list of doubles, to find 4.5 in the list, use:
int index = list.BinarySearch(d => d.CompareTo(4.5)) |
| BinarySearchICoordinate(ICoordinate, IComparerICoordinate) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval] |
| BinarySearchICoordinate, TKey(FuncICoordinate, TKey, TKey) | Overloaded.
Searches the entire sorted IListT for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval]This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. |
| BinarySearchICoordinate, TKey(FuncICoordinate, TKey, TKey, IComparerTKey) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval]This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. |
| CastToList |
Cast an ICoordinateSequence to an CoordinateList,
create a new if a cast is not possible
(Defined by SpatialExtensions.) |
| DirectionUnitVector |
Finds the local reach direction as the direction from the locally surounding digi points. The
vector returned is a unit vector.
(Defined by SpatialExtensions.) |
| DirectionUnitVectorSmooth |
Finds the local reach direction as the direction from the locally surrounding digi points. The
vector returned is a unit vector.
(Defined by SpatialExtensions.)This returns a smoothly varying unit vector: On the center of the line between two digipoints, the direction of the line is returned. On a digipoint the average of the line before and after the digipoint is returned. In between the center of the line and the digipoint the direction varies linearly. |
| LocateAlong(Double) | Overloaded.
Locate a coordinate where the m value
is located in the coords.
(Defined by SpatialExtensions.) |
| LocateAlong(Double, ExtrapolationTypes) | Overloaded.
Locate a coordinate where the m value
is located in the coords.
(Defined by SpatialExtensions.)If extrapolate is true, the coordinates are extrapolated. If only one coordinate exist in coords, return that coordinate. Extrapoloation types 'Nearest' and 'Linear is supported'. |
| LocateAlong(Double, ExtrapolationTypes, Double) | Overloaded.
Locate a coordinate where the m value
is located in the coords.
(Defined by SpatialExtensions.)If extrapolate is true, the coordinates are extrapolated within the extrapolation distance. If only one coordinate exist in coords, return that coordinate. Extrapoloation types 'Nearest' and 'Linear is supported'. |
| SortICoordinate | Overloaded.
Sorts the elements in the entire List{T} using the default comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| SortICoordinate(IComparerICoordinate) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| SortStableICoordinate | Overloaded. (Defined by GenericExtensions.) |
| SortStableICoordinate(IComparerICoordinate) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
| SortStableICoordinate(ComparisonICoordinate) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
See Also