Click or drag to resize

DataItem Properties

The DataItem type exposes the following members.

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
See Also