Click or drag to resize

TimeDataCircularValue Class

Implementation of ITimeData for a single valued item
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Generic.CollectionsFifoQueueSingle
    DHI.Mike1D.ResultDataAccessTimeDataCircularValue

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class TimeDataCircularValue : FifoQueue<float>, 
	ITimeData, INumericArray, IReadOnlyList<double>, IEnumerable<double>, 
	IEnumerable, IReadOnlyCollection<double>

The TimeDataCircularValue type exposes the following members.

Constructors
  NameDescription
Public methodTimeDataCircularValue
Initializes a new instance of the TimeDataValue class that is empty and has the default initial time step capacity.
Public methodTimeDataCircularValue(Int32)
Initializes a new instance of the TimeDataValue class that is empty and has the specified initial time step capacity.
Top
Properties
Methods
  NameDescription
Public methodAdd
Adds a time step, with empty data
Public methodAdd(T)
Adds an object to the end of the FifoQueue{T}, same as Enqueue(T)
(Inherited from FifoQueueT.)
Public methodAdd(Single)
Adds a time step, setting the provided values

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

Public methodAddRange
Adds an object to the end of the FifoQueue{T}, same as Enqueue(T)
(Inherited from FifoQueueT.)
Public methodAddRotate
Adds an object to the end of the FifoQueue{T}, dequeuing the first item if queue is full (capacity is met).
(Inherited from FifoQueueT.)
Public methodClear
Removes all objects from the FifoQueue{T}.
(Inherited from FifoQueueT.)
Public methodContains (Inherited from FifoQueueT.)
Public methodCopyTo (Inherited from FifoQueueT.)
Public methodDequeue
Removes and returns the object at the beginning of the FifoQueue{T}.
(Inherited from FifoQueueT.)
Public methodEnqueue
Adds an object to the end of the FifoQueue{T}.
(Inherited from FifoQueueT.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the FifoQueue{T}.
(Inherited from FifoQueueT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(Int32)
Public methodGetValue(Int32, Int32)
Get value for the speficied time step and element
Public methodGetValues
Get values for all elements for the speficied time step

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

Protected methodIndex
Index in internal _q array _q of the element with index in queue, handling circular array wrapping.
(Inherited from FifoQueueT.)
Public methodIndexOf (Inherited from FifoQueueT.)
Public methodInsert (Inherited from FifoQueueT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPeek
Returns the object at the beginning of the FifoQueue{T} without removing it.
(Inherited from FifoQueueT.)
Public methodPushBack
Put the first element to the end of the queue
(Inherited from FifoQueueT.)
Public methodRemove (Inherited from FifoQueueT.)
Public methodRemoveAt (Inherited from FifoQueueT.)
Public methodSetValue(Int32, Double)
Public methodSetValue(Int32, Int32, Single)
Set value at the speficied time step and element

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

Public methodSetValues
Set values for all elements at the speficied time step

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

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodGetValue
Interplate a value in interval, with fraction, for the specified elementIndex
(Defined by ResultDataExtensions.)
Top
See Also