Click or drag to resize

DataItem Class

Inheritance Hierarchy

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
[SerializableAttribute]
public class DataItem : IDataItem

The DataItem type exposes the following members.

Constructors
  NameDescription
Public methodDataItem
Constructor
Top
Properties
  NameDescription
Public propertyIndexList

For each element this can specify an index into another list where the data "belongs" to.

This can be null (if no reasonable correspondance exists or if the correspondance is trivial and therefor not needed ([0,1,2,3,...])).

For data on a reach, the element at index i in the IndexList having IndexList[i] = j is used to specify that the value belongs to GridPoint number j in a list of GridPoint's.

Public propertyItemId
Id of item that this quantity belongs to. Null if not relevant.

Used e.g. to store the Id of the structure that the data belongs to.

Public propertyItemTypeGroup
Describes what data group the data belongs to
Public propertyNumberOfElements
Number of elements.
Public propertyNumberOfTimeSteps
Number of time steps in data item.

Matches NumberOfTimeSteps, unless data for DataItem is not loaded, in which case it is zero

Public propertyNumberWithinGroup
Number within the group of ItemTypeGroup. Zero based.

If the number is -1, then the data belongs to all items within the ItemTypeGroup, i.e. if the ItemTypeGroup is NodeItem, then there is data for all nodes in the network.

Public propertyQuantity
Quantity description
Public propertyTimeData
List of time step data. Each list member contains data for one time step, The list has NumberOfTimeSteps elements.
Public propertyVectorData
Flag indicating if data item contains vector data or single value data
Top
Methods
  NameDescription
Public methodClear
Clear data item for time dependent data
Public methodCreateDataArray
The property exposes the contained data as a two dimensional array. The array is [number of time steps, number of points]. The array is constructed every time called as a copy of Data, and not updated if the underlying Data is updated.
Public methodCreateTimeSeriesData
Create an array of values for a given point with the given index, each element in the array corresponding the a given time.

Values are returned for the point at Chainages[pointIndex].

The result is an array having NumberOfTimeSteps elements.

The array is constructed every time called as a copy of the data in the data item.

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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the value for the element at the given element index and time index. Short-cut for GetValue(Int32, Int32)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate(DateTime)
Update the TimeData with a new set of time step values
Public methodUpdate(DateTime, Int32)
Update the TimeData with a new set of time step values
Top
Fields
  NameDescription
Protected field_indexList
List with indexes
Protected field_itemId
Item Id
Protected field_itemTypeGroup
Item type group
Protected field_numberWithinGroup
Index within group
Protected field_quantity
Data quantity
Protected field_timeData
Data at time steps in vector case
Protected field_vectorData
Flag indicating if data item contains vector data or single value data
Top
See Also