Reaches Class

Class implementing a list of IReach's Required for generic list COM interop

Inheritance Hierarchy

System.Object
System.Collections.Generic.List<IReach>
DHI.Mike1D.NetworkDataAccess.Reaches

Namespace: DHI.Mike1D.NetworkDataAccess
Assembly: DHI.Mike1D.NetworkDataAccess (in DHI.Mike1D.NetworkDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class Reaches : List<IReach>, 
	IReaches, IList<IReach>, ICollection<IReach>, 
	IEnumerable<IReach>, IEnumerable

Public Class Reaches
	Inherits List(Of IReach)
	Implements IReaches, IList(Of IReach), 
	ICollection(Of IReach), IEnumerable(Of IReach), IEnumerable

public ref class Reaches : public List<IReach^>, 
	IReaches, IList<IReach^>, ICollection<IReach^>, 
	IEnumerable<IReach^>, IEnumerable

The Reaches type exposes the following members.

Constructors

	Name	Description
	Reaches()	Initializes a new instance of the List class that is empty and has the default initial capacity.
	Reaches(Int32)	Initializes a new instance of the List class that is empty and has the specified initial capacity.
	Reaches(IEnumerable<IReach>)	Initializes a new instance of the List class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied.

Top

Properties

	Name	Description
	Capacity	Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from List<IReach>.)
	Count	Gets the number of elements contained in the List<T>. (Inherited from List<IReach>.)
	Item	Gets or sets the element at the specified index. (Inherited from List<IReach>.)

Top

Methods

	Name	Description
	Add	Adds an object to the end of the List<T>. (Inherited from List<IReach>.)
	AddRange	Adds the elements of the specified collection to the end of the List<T>. (Inherited from List<IReach>.)
	AsReadOnly	Returns a read-only ReadOnlyCollection<T> wrapper for the current collection. (Inherited from List<IReach>.)
	BinarySearch(T)	Searches the entire sorted List<T> for an element using the default comparer and returns the zero-based index of the element. (Inherited from List<IReach>.)
	BinarySearch(T, IComparer<T>)	Searches the entire sorted List<T> for an element using the specified comparer and returns the zero-based index of the element. (Inherited from List<IReach>.)
	BinarySearch(Int32, Int32, T, IComparer<T>)	Searches a range of elements in the sorted List<T> for an element using the specified comparer and returns the zero-based index of the element. (Inherited from List<IReach>.)
	Clear	Removes all elements from the List<T>. (Inherited from List<IReach>.)
	Contains	Determines whether an element is in the List<T>. (Inherited from List<IReach>.)
	ConvertAll<TOutput>	Converts the elements in the current List<T> to another type, and returns a list containing the converted elements. (Inherited from List<IReach>.)
	CopyTo(T[])	Copies the entire List<T> to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from List<IReach>.)
	CopyTo(T[], Int32)	Copies the entire List<T> to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from List<IReach>.)
	CopyTo(Int32,T[], Int32, Int32)	Copies a range of elements from the List<T> to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from List<IReach>.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Exists	Determines whether the List<T> contains elements that match the conditions defined by the specified predicate. (Inherited from List<IReach>.)
	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 List<T>. (Inherited from List<IReach>.)
	FindAll	Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from List<IReach>.)
	FindIndex(Predicate<T>)	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 List<T>. (Inherited from List<IReach>.)
	FindIndex(Int32, Predicate<T>)	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 List<T> that extends from the specified index to the last element. (Inherited from List<IReach>.)
	FindIndex(Int32, Int32, Predicate<T>)	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 List<T> that starts at the specified index and contains the specified number of elements. (Inherited from List<IReach>.)
	FindLast	Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List<T>. (Inherited from List<IReach>.)
	FindLastIndex(Predicate<T>)	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 List<T>. (Inherited from List<IReach>.)
	FindLastIndex(Int32, Predicate<T>)	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 List<T> that extends from the first element to the specified index. (Inherited from List<IReach>.)
	FindLastIndex(Int32, Int32, Predicate<T>)	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 List<T> that contains the specified number of elements and ends at the specified index. (Inherited from List<IReach>.)
	ForEach	Performs the specified action on each element of the List<T>. (Inherited from List<IReach>.)
	GetEnumerator	Returns an enumerator that iterates through the List<T>. (Inherited from List<IReach>.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRange	Creates a shallow copy of a range of elements in the source List<T>. (Inherited from List<IReach>.)
	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 List<T>. (Inherited from List<IReach>.)
	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 List<T> that extends from the specified index to the last element. (Inherited from List<IReach>.)
	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 List<T> that starts at the specified index and contains the specified number of elements. (Inherited from List<IReach>.)
	Insert	Inserts an element into the List<T> at the specified index. (Inherited from List<IReach>.)
	InsertRange	Inserts the elements of a collection into the List<T> at the specified index. (Inherited from List<IReach>.)
	LastIndexOf(T)	Searches for the specified object and returns the zero-based index of the last occurrence within the entire List<T>. (Inherited from List<IReach>.)
	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 List<T> that extends from the first element to the specified index. (Inherited from List<IReach>.)
	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 List<T> that contains the specified number of elements and ends at the specified index. (Inherited from List<IReach>.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific object from the List<T>. (Inherited from List<IReach>.)
	RemoveAll	Removes all the elements that match the conditions defined by the specified predicate. (Inherited from List<IReach>.)
	RemoveAt	Removes the element at the specified index of the List<T>. (Inherited from List<IReach>.)
	RemoveRange	Removes a range of elements from the List<T>. (Inherited from List<IReach>.)
	Reverse()	Reverses the order of the elements in the entire List<T>. (Inherited from List<IReach>.)
	Reverse(Int32, Int32)	Reverses the order of the elements in the specified range. (Inherited from List<IReach>.)
	Sort()	Sorts the elements in the entire List<T> using the default comparer. (Inherited from List<IReach>.)
	Sort(IComparer<T>)	Sorts the elements in the entire List<T> using the specified comparer. (Inherited from List<IReach>.)
	Sort(Comparison<T>)	Sorts the elements in the entire List<T> using the specified Comparison<T>. (Inherited from List<IReach>.)
	Sort(Int32, Int32, IComparer<T>)	Sorts the elements in a range of elements in List<T> using the specified comparer. (Inherited from List<IReach>.)
	ToArray	Copies the elements of the List<T> to a new array. (Inherited from List<IReach>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrimExcess	Sets the capacity to the actual number of elements in the List<T>, if that number is less than a threshold value. (Inherited from List<IReach>.)
	TrueForAll	Determines whether every element in the List<T> matches the conditions defined by the specified predicate. (Inherited from List<IReach>.)

Top

Extension Methods

	Name	Description
	BinarySearch(ILocation)	Overloaded. Find the reach that includes the given location. Assuming the reaches are sorted. Location comparisons are case insensitive. (Defined by NetworkExtensions.)
	BinarySearch(ILocation, Double)	Overloaded. Find the reach that includes the given location. Assuming the reaches are sorted. Location comparisons are case insensitive, and chainage comparisons uses the tolerance, i.e., the location can be tolerance outside the span and still be accepted. tolerance may be negative (it location has to be somewhat inside span). (Defined by NetworkExtensions.)
	BinarySearch<IReach>(IReach)	Overloaded. Searches the entire sorted IList<T> for an element and returns the zero-based index of the element. 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. Copy list[interval-1] < key < list[interval] (Defined by GenericExtensions.)
	BinarySearch<IReach>(Func<IReach, Int32>)	Overloaded. Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element. 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: Copy int index = list.BinarySearch(d => d.CompareTo(4.5)) (Defined by GenericExtensions.)
	BinarySearch<IReach>(IReach, IComparer<IReach>)	Overloaded. Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element. 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. Copy list[interval-1] < key < list[interval] (Defined by GenericExtensions.)
	BinarySearch<IReach, TKey>(Func<IReach, TKey>, TKey)	Overloaded. Searches the entire sorted IList<T> for an element and returns the zero-based index of the element. 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. Copy 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. (Defined by GenericExtensions.)
	BinarySearch<IReach, TKey>(Func<IReach, TKey>, TKey, IComparer<TKey>)	Overloaded. Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element. 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. Copy 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. (Defined by GenericExtensions.)
	FindIndex<IReach>(Predicate<IReach>)	Overloaded. 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 list. (Defined by GenericExtensions.)
	FindIndex<IReach>(Int32, Predicate<IReach>)	Overloaded. 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 List<T> that extends from the specified index to the last element. (Defined by GenericExtensions.)
	Sort()	Overloaded. Sorts a list of reaches, first based on their ID, secondly on their start chainage value (Defined by NetworkExtensions.)
	Sort<IReach>()	Overloaded. Sorts the elements in the entire List{T} using the default comparer. 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). (Defined by GenericExtensions.)
	Sort<IReach>(IComparer<IReach>)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. 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). (Defined by GenericExtensions.)
	SortStable<IReach>()	Overloaded. (Defined by GenericExtensions.)
	SortStable<IReach>(IComparer<IReach>)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. (Defined by GenericExtensions.)
	SortStable<IReach>(Comparison<IReach>)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. (Defined by GenericExtensions.)

Top

Reference

DHI.Mike1D.NetworkDataAccess Namespace