Click or drag to resize

EngineNetDataItemAllT Class

An IEngineNetDataItemT that can contain data for either no or all nodes, and either no or all reaches.

That is, it contains a list of all reaches and nodes in the engine network. In case a reach/node does not have data for a quantity, the IEngineData for that reach/node will be null.

A data item can either calculate its values on the fly, when its GetValues is called are called, or it can update its values during UpdateValues.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineNetDataItemAllT

Namespace:  DHI.Mike1D.Engine.ModuleData
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)
Syntax
C#
public class EngineNetDataItemAll<T> : IEngineNetDataItem<T>

Type Parameters

T

The EngineNetDataItemAllT type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyDataGeneric
Get engine data for the specified index reference.
Public propertyDataGenericDefDefinition
Get data definition for the generic data - by default null
Public propertyQuantity
Top
Methods
  NameDescription
Public methodContainsDataGeneric
Check whether there is data for the index reference
Public methodContainsDataNode
Check whether there is data for the specified node
Public methodContainsDataReach
Check whether there is data for the specified reach
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 methodGetDataNode
Get engine data for the specified node.
Public methodGetDataReach
Get engine data for the specified reach.
Public methodGetDataReachDefinition
Get data definition for the data at the specified reach.

Returns an index-list, being indices of gridpoints that data belong to. In this case the elementSet is not required and may be null.

If data does not belong to grid points, the returned index-list must be null, and the elementSet must be used to describe the extent of each value in the reach.

If data belongs to all grid points in the reach, i.e. the number of values matches the number of grid points in the reach, both the returned index-list and the elementSet can be null.

Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare for new simulation
Public methodSetupDataForNodes
Setup data for all nodes
Public methodSetupDataForReaches
Set up reach data
Public methodSetupDataForReachesHPoints
Set up reach data for all H points in a HD reach
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateValues
Update values of all pull items
Top
Fields
  NameDescription
Protected field_defaultValue
Default value
Protected field_undefinedValue
Value used as undefined value
Public fieldGenericData
Generic data
Public fieldNodesData
Data on nodes
Public fieldReachesData
Data on reaches
Top
See Also