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

C++

Copy

public class TimeDataCircularValue : FifoQueue<float>, 
	ITimeData, INumericArray, IReadOnlyList<double>, IEnumerable<double>, 
	IEnumerable, IReadOnlyCollection<double>

Public Class TimeDataCircularValue
	Inherits FifoQueue(Of Single)
	Implements ITimeData, INumericArray, IReadOnlyList(Of Double), 
	IEnumerable(Of Double), IEnumerable, IReadOnlyCollection(Of Double)

public ref class TimeDataCircularValue : public FifoQueue<float>, 
	ITimeData, INumericArray, IReadOnlyList<double>, IEnumerable<double>, 
	IEnumerable, IReadOnlyCollection<double>

The TimeDataCircularValue type exposes the following members.

Constructors

	Name	Description
	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.

Top

Properties

	Name	Description
	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.)

Top

Methods

	Name	Description
	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.)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from FifoQueueT.)
	CopyTo	Copies 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.)
	Enqueue	Adds an object to the end of the FifoQueue{T}. (Inherited from FifoQueueT.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows 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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets 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.)
	IndexOf	Determines the index of a specific item in the IListT. (Inherited from FifoQueueT.)
	Insert	Inserts an item to the IListT at the specified index. (Inherited from FifoQueueT.)
	MemberwiseClone	Creates 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.)
	PushBack	Put the first element to the end of the queue (Inherited from FifoQueueT.)
	Remove	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from FifoQueueT.)
	RemoveAt	Removes 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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	_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.)

Top

Extension Methods

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

Top

Reference

DHI.Mike1D.ResultDataAccess Namespace