IDataItem Interface |
An IDataItem contains data for one quantity and for a number of time steps and elements. For each set of time data there is an array of data element values.
Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IDataItem type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | IndexList | 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. |
| ItemId |
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. |
| ItemTypeGroup |
Describes what data group the data belongs to
|
| NumberOfElements |
Number of elements.
|
| NumberOfTimeSteps |
Number of time steps in data item.
Matches NumberOfTimeSteps, unless data for DataItem is not loaded, in which case it is zero |
| NumberWithinGroup |
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. |
| Quantity |
Quantity description
|
| TimeData |
List of time step data. Each list member contains data for one time step,
The list has NumberOfTimeSteps elements.
|
| VectorData |
Flag indicating if data item contains vector data or single value data
|
Methods| Name | Description | |
|---|---|---|
 | Clear |
Clear data item for time dependent data
|
| CreateDataArray | The method 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. para> |
| CreateTimeSeriesData |
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. |
| GetValue |
Returns the value for the element at the given element index and
time index. Short-cut for GetValue(Int32, Int32) |
| Update(DateTime) |
Update the TimeData with a new set of time step values
|
| Update(DateTime, Int32) |
Update the TimeData with a new set of time step values
|
See Also