ICatchments Interface

Note: This API is now obsolete.
Interface to Rainfall Runoff Model catchments

Definition

Namespace: DHI.Mike1D.RainfallRunoffModule
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
[ObsoleteAttribute("Will be removed in future versions")]
public interface ICatchments : IList<ICatchment>, 
	ICollection<ICatchment>, IEnumerable<ICatchment>, IEnumerable, 
	IReadOnlyList<ICatchment>, IReadOnlyCollection<ICatchment>
Implements
ICollectionICatchment, IEnumerableICatchment, IListICatchment, IReadOnlyCollectionICatchment, IReadOnlyListICatchment, IEnumerable

Properties

CountGets the number of elements contained in the ICollectionT.
(Inherited from ICollectionICatchment)
IsReadOnlyGets a value indicating whether the ICollectionT is read-only.
(Inherited from ICollectionICatchment)
ItemGets or sets the element at the specified index.
(Inherited from IListICatchment)

Methods

AddAdds an item to the ICollectionT.
(Inherited from ICollectionICatchment)
ClearRemoves all items from the ICollectionT.
(Inherited from ICollectionICatchment)
ContainsDetermines whether the ICollectionT contains a specific value.
(Inherited from ICollectionICatchment)
CopyToCopies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ICollectionICatchment)
Find Find a catchment by catchment model id (unique)
FindAll Find a catchment by catchment name
GetEnumeratorReturns an enumerator that iterates through the collection.
(Inherited from IEnumerableICatchment)
IndexOfDetermines the index of a specific item in the IListT.
(Inherited from IListICatchment)
Initialize Initialize Rainfall Runoff models. Sets up static data.
InsertInserts an item to the IListT at the specified index.
(Inherited from IListICatchment)
Prepare Prepare Rainfall Runoff models. Sets up dynamic data so that the model is ready for first time step.
RemoveRemoves the first occurrence of a specific object from the ICollectionT.
(Inherited from ICollectionICatchment)
RemoveAtRemoves the IListT item at the specified index.
(Inherited from IListICatchment)

Extension Methods

BinarySearchICatchment 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.

Example

If having a list of doubles, to find 4.5 in the list, use: int index = list.BinarySearch(d => d.CompareTo(4.5))

(Defined by GenericExtensions)
BinarySearchICatchment 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. list[interval-1] < key < list[interval]


(Defined by GenericExtensions)
BinarySearchICatchment 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. list[interval-1] < key < list[interval]


(Defined by GenericExtensions)
BinarySearchICatchment, TKey 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. 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)
BinarySearchICatchment, TKey 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. 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)
BinarySearchROICatchment, TKey Searches the entire sorted IReadOnlyListT 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. 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)
BinarySearchROICatchment, TKey Searches the entire sorted IReadOnlyListT 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. 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)
FindAll Find all catchments with the specified name, and providing the specified quantity
(Defined by RRExtensions)
FindIndexICatchmentSearches 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)
FindIndexICatchmentSearches 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)
SortICatchment 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)
SortICatchment 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)
SortStableICatchment Sorts the elements in the entire List{T} using the default 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)
SortStableICatchment 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)
SortStableICatchment 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)

See Also