TimeDataCircularValue Class

Implementation of ITimeData for a single valued item

Definition

Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class TimeDataCircularValue : FifoQueue<float>, 
	ITimeData, INumericArray, IReadOnlyList<double>, IEnumerable<double>, 
	IEnumerable, IReadOnlyCollection<double>
Inheritance
Object    FifoQueueSingle    TimeDataCircularValue
Implements
INumericArray, ITimeData, IEnumerableDouble, IReadOnlyCollectionDouble, IReadOnlyListDouble, IEnumerable

Constructors

TimeDataCircularValue Initializes a new instance of the TimeDataValue class that is empty and has the default initial time step capacity.
TimeDataCircularValue(Int32) Initializes a new instance of the TimeDataValue class that is empty and has the specified initial time step capacity.

Properties

Array An array representation of the current content of the queue.

Note that this will make a copy of the internal array


(Inherited from FifoQueueT)
Capacity Gets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from FifoQueueT)
Count Gets the number of elements contained in the FifoQueue{T}.
(Inherited from FifoQueueT)
Item Gets/sets the element at the specified position in the FifoQueue{T}.
(Inherited from FifoQueueT)
NumberOfElements Number of elements.
NumberOfTimeSteps Number of time steps.
Tail Index in internal _q array of last element in the queue
(Inherited from FifoQueueT)

Methods

Add Adds a time step, with empty data
Add(T) Adds an object to the end of the FifoQueue{T}, same as Enqueue(T)
(Inherited from FifoQueueT)
Add(Single) Adds a time step, setting the provided values

calling this method is only valid if NumberOfElements is greater than 1.

AddRange Adds an object to the end of the FifoQueue{T}, same as Enqueue(T)
(Inherited from FifoQueueT)
AddRotate Adds an object to the end of the FifoQueue{T}, dequeuing the first item if queue is full (capacity is met).
(Inherited from FifoQueueT)
Clear Removes all objects from the FifoQueue{T}.
(Inherited from FifoQueueT)
ContainsDetermines whether the ICollectionT contains a specific value.
(Inherited from FifoQueueT)
CopyToCopies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from FifoQueueT)
Dequeue Removes and returns the object at the beginning of the FifoQueue{T}.
(Inherited from FifoQueueT)
Drop Removes the object at the beginning of the FifoQueue{T}.
(Inherited from FifoQueueT)
Enqueue Adds an object to the end of the FifoQueue{T}.
(Inherited from FifoQueueT)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetEnumerator Returns an enumerator that iterates through the FifoQueue{T}.
(Inherited from FifoQueueT)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(Int32) 
GetValue(Int32, Int32) Get value for the speficied time step and element
GetValues Get values for all elements for the speficied time step

calling this method is only valid if NumberOfElements is greater than 1.

Index Index in internal _q array _q of the element with index in queue, handling circular array wrapping.
(Inherited from FifoQueueT)
IndexOfDetermines the index of a specific item in the IListT.
(Inherited from FifoQueueT)
InsertInserts an item to the IListT at the specified index.
(Inherited from FifoQueueT)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Peek Returns the object at the beginning of the FifoQueue{T} without removing it.
(Inherited from FifoQueueT)
Poke Returns the object at the end of the FifoQueue{T} (the one added last) without removing it.
(Inherited from FifoQueueT)
PushBack Put the first element to the end of the queue
(Inherited from FifoQueueT)
RemoveRemoves the first occurrence of a specific object from the ICollectionT.
(Inherited from FifoQueueT)
RemoveAtRemoves the IListT item at the specified index.
(Inherited from FifoQueueT)
SetValue(Int32, Double) 
SetValue(Int32, Int32, Single) Set value at the speficied time step and element

For single valued items, when NumberOfElements equals 1, set elementIndex to zero.

SetValues Set values for all elements at the speficied time step

calling this method is only valid if NumberOfElements is greater than 1.

ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

_count Number of elements currently in the queue/circular array
(Inherited from FifoQueueT)
_head Index of first element in circular array _q
(Inherited from FifoQueueT)
_q Internal array of queue values, used as circular array.
(Inherited from FifoQueueT)

Extension Methods

BinarySearchRODouble, 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)
BinarySearchRODouble, 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)
Expand Expand timeData from timestepIndex and assure room for length new time steps. If those time steps are already available, this does nothing.

The timestepIndex must be within or just after the end of the current set of time steps in timeData


(Defined by ResultDataExtensions)
GetValue Interplate a value in interval, with fraction, for the specified elementIndex
(Defined by ResultDataExtensions)

See Also