Locations Class

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

Inheritance Hierarchy

SystemObject
System.Collections.GenericListILocation
DHI.Mike1D.GenericLocations

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

Syntax

C++

Copy

public class Locations : List<ILocation>, 
	ILocations, IEnumerable<ILocation>, IEnumerable, IList<ILocation>, 
	ICollection<ILocation>

Public Class Locations
	Inherits List(Of ILocation)
	Implements ILocations, IEnumerable(Of ILocation), 
	IEnumerable, IList(Of ILocation), ICollection(Of ILocation)

public ref class Locations : public List<ILocation^>, 
	ILocations, IEnumerable<ILocation^>, IEnumerable, IList<ILocation^>, 
	ICollection<ILocation^>

The Locations type exposes the following members.

Constructors

	Name	Description
	Locations	Initializes a new instance of the List class that is empty and has the default initial capacity.
	Locations(Int32)	Initializes a new instance of the List class that is empty and has the specified initial capacity.
	Locations(IEnumerableILocation)	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 ListILocation.)
	Count	Gets the number of elements contained in the ListT. (Inherited from ListILocation.)
	Item	Gets or sets the element at the specified index. (Inherited from ListILocation.)

Top

Methods

	Name	Description
	Add	Adds an object to the end of the ListT. (Inherited from ListILocation.)
	AddRange	Adds the elements of the specified collection to the end of the ListT. (Inherited from ListILocation.)
	AsReadOnly	Returns a read-only ReadOnlyCollectionT wrapper for the current collection. (Inherited from ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	Clear	Removes all elements from the ListT. (Inherited from ListILocation.)
	Contains	Determines whether an element is in the ListT. (Inherited from ListILocation.)
	ConvertAllTOutput	Converts the elements in the current ListT to another type, and returns a list containing the converted elements. (Inherited from ListILocation.)
	CopyTo(T)	Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from ListILocation.)
	CopyTo(T, Int32)	Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	FindAll	Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	ForEach	Performs the specified action on each element of the ListT. (Inherited from ListILocation.)
	GetEnumerator	Returns an enumerator that iterates through the ListT. (Inherited from ListILocation.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRange	Creates a shallow copy of a range of elements in the source ListT. (Inherited from ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	Insert	Inserts an element into the ListT at the specified index. (Inherited from ListILocation.)
	InsertRange	Inserts the elements of a collection into the ListT at the specified index. (Inherited from ListILocation.)
	LastIndexOf(T)	Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	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 ListILocation.)
	RemoveAll	Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ListILocation.)
	RemoveAt	Removes the element at the specified index of the ListT. (Inherited from ListILocation.)
	RemoveRange	Removes a range of elements from the ListT. (Inherited from ListILocation.)
	Reverse	Reverses the order of the elements in the entire ListT. (Inherited from ListILocation.)
	Reverse(Int32, Int32)	Reverses the order of the elements in the specified range. (Inherited from ListILocation.)
	Sort	Sorts the elements in the entire ListT using the default comparer. (Inherited from ListILocation.)
	Sort(IComparerT)	Sorts the elements in the entire ListT using the specified comparer. (Inherited from ListILocation.)
	Sort(ComparisonT)	Sorts the elements in the entire ListT using the specified ComparisonT. (Inherited from ListILocation.)
	Sort(Int32, Int32, IComparerT)	Sorts the elements in a range of elements in ListT using the specified comparer. (Inherited from ListILocation.)
	ToArray	Copies the elements of the ListT to a new array. (Inherited from ListILocation.)
	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 ListILocation.)
	TrueForAll	Determines whether every element in the ListT matches the conditions defined by the specified predicate. (Inherited from ListILocation.)

Top

Extension Methods

	Name	Description
	BinarySearchILocation(ILocation)	Overloaded. Searches the entire sorted IListT 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.)
	BinarySearchILocation(FuncILocation, Int32)	Overloaded. Searches the entire sorted IListT 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.)
	BinarySearchILocation(ILocation, IComparerILocation)	Overloaded. Searches the entire sorted IListT 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.)
	BinarySearchILocation, TKey(FuncILocation, TKey, TKey)	Overloaded. Searches the entire sorted IListT 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.)
	BinarySearchILocation, TKey(FuncILocation, 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. 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.)
	FindIndexILocation(PredicateILocation)	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.)
	FindIndexILocation(Int32, PredicateILocation)	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 ListT that extends from the specified index to the last element. (Defined by GenericExtensions.)
	SortILocation	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.)
	SortILocation(IComparerILocation)	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.)
	SortStableILocation	Overloaded. (Defined by GenericExtensions.)
	SortStableILocation(IComparerILocation)	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.)
	SortStableILocation(ComparisonILocation)	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.Generic Namespace