ICatchments Interface

Note: This API is now obsolete.

Interface to Rainfall Runoff Model catchments

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

Syntax

C++

Copy

[ObsoleteAttribute("Will be removed in future versions")]
public interface ICatchments : IList<ICatchment>, 
	ICollection<ICatchment>, IEnumerable<ICatchment>, IEnumerable, 
	IReadOnlyList<ICatchment>, IReadOnlyCollection<ICatchment>

<ObsoleteAttribute("Will be removed in future versions")>
Public Interface ICatchments
	Inherits IList(Of ICatchment), ICollection(Of ICatchment), 
	IEnumerable(Of ICatchment), IEnumerable, IReadOnlyList(Of ICatchment), 
	IReadOnlyCollection(Of ICatchment)

[ObsoleteAttribute(L"Will be removed in future versions")]
public interface class ICatchments : IList<ICatchment^>, 
	ICollection<ICatchment^>, IEnumerable<ICatchment^>, IEnumerable, 
	IReadOnlyList<ICatchment^>, IReadOnlyCollection<ICatchment^>

The ICatchments type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT. (Inherited from ICollectionICatchment.)
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from ICollectionICatchment.)
	Item	Gets or sets the element at the specified index. (Inherited from IListICatchment.)

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT. (Inherited from ICollectionICatchment.)
	Clear	Removes all items from the ICollectionT. (Inherited from ICollectionICatchment.)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from ICollectionICatchment.)
	CopyTo	Copies 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
	GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from IEnumerableICatchment.)
	IndexOf	Determines the index of a specific item in the IListT. (Inherited from IListICatchment.)
	Initialize	Initialize Rainfall Runoff models. Sets up static data.
	Insert	Inserts 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.
	Remove	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ICollectionICatchment.)
	RemoveAt	Removes the IListT item at the specified index. (Inherited from IListICatchment.)

Top

Extension Methods

	Name	Description
	BinarySearchICatchment(ICatchment)	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.)
	BinarySearchICatchment(FuncICatchment, 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.)
	BinarySearchICatchment(ICatchment, IComparerICatchment)	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.)
	BinarySearchICatchment, TKey(FuncICatchment, 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.)
	BinarySearchICatchment, TKey(FuncICatchment, 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.)
	FindAll	Find all catchments with the specified name, and providing the specified quantity (Defined by RRExtensions.)
	FindIndexICatchment(PredicateICatchment)	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.)
	FindIndexICatchment(Int32, PredicateICatchment)	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.)
	SortICatchment	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.)
	SortICatchment(IComparerICatchment)	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.)
	SortStableICatchment	Overloaded. (Defined by GenericExtensions.)
	SortStableICatchment(IComparerICatchment)	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.)
	SortStableICatchment(ComparisonICatchment)	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.RainfallRunoffModule Namespace