Click or drag to resize

EngineDataItemAllT Class

An IEngineDataItemT that can contain data for either no or all nodes, and either no or all reaches. Engine data is on the form of IEngineDataNodeT for nodes and IEngineDataReachT for reaches. These are appropriate for pull-versions of data items, adding user implementations of the two interfaces.

The AbstractEngineDataNodeT and AbstractEngineDataReachT can be used as base implementations for pull versions of engine data.

This class 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, in which case the UpdateValues must be overwritten.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineDataItemAllBaseT
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllT
      More...

Namespace:  DHI.Mike1D.Engine.ModuleData
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class EngineDataItemAll<T> : EngineDataItemAllBase<T>, 
	IEngineDataItem<T>

Type Parameters

T

[Missing <typeparam name="T"/> documentation for "T:DHI.Mike1D.Engine.ModuleData.EngineDataItemAll`1"]

The EngineDataItemAllT type exposes the following members.

Constructors
Properties
Methods
  NameDescription
Public methodContainsDataGeneric
Check whether there is data for the index reference
(Inherited from EngineDataItemAllBaseT.)
Public methodContainsDataNode
Check whether there is data for the specified node
Public methodContainsDataReach
Check whether there is data for the specified reach
Public methodContainsDataReachGeneric
Check whether there is generic data for the specified reach
(Inherited from EngineDataItemAllBaseT.)
Public methodStatic memberCreateDataItemForAllReaches
Factory method for creating a dataitem containing data for all reaches. The data for each reach are created by the delegate
Public methodCreateGridPointMap
For every reach, create a mapping from grid point index in reach to grid point index in enginedata item.
Protected methodCreateReachesData
Create ReachesData, usually array of all reaches
(Overrides EngineDataItemAllBaseTCreateReachesData(Int32).)
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 methodGetDataReach
Get engine data for the specified reach.
Public methodGetDataReachGeneric
Get generic engine data for the specified reach.
(Inherited from EngineDataItemAllBaseT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNodeData
Get engine data for the specified node.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Get engine data for the specified node.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare (Inherited from EngineDataItemAllBaseT.)
Protected methodSetEngineDataReach
Set reach data to reaches array
(Overrides EngineDataItemAllBaseTSetEngineDataReach(Int32, EngineDataReachT).)
Public methodSetupDataForNodes(EngineNet)
Setup data for all nodes
Public methodSetupDataForNodes(EngineNet, EngineDataItemAllTDCreateNodeDataT)
Setup data for all nodes
Public methodSetupDataForReaches(EngineNet)
Set up reach data, data on all gridpoints
(Inherited from EngineDataItemAllBaseT.)
Public methodSetupDataForReaches(EngineNet, EngineDataItemAllTDCreateReachDataT)
Set up reach data, based on delegate
Public methodCode exampleSetupDataForReaches(EngineNet, PredicateGridPoint)
Set up reach data, data on all gridpoints of a given instance type
Public methodCode exampleSetupDataForReaches(EngineNet, Type)
Set up reach data, data on all gridpoints of a given instance type
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateValues
Update values of all pull items
(Inherited from EngineDataItemAllBaseT.)
Public methodValueFractionGetter
Valuegetter for engine data for the specified node.
Public methodValueGetter
Valuegetter for engine data for the specified node.
Top
Fields
Extension Methods
See Also
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineDataItemAllBaseT
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllT
      DHI.Mike1D.Engine.AddOnsHDFloodedArea
      DHI.Mike1D.Engine.AddOnsHDInOutFlowCalculator
      DHI.Mike1D.Engine.AddOnsHDMassErrorAccumulatedChecksumCalculator
      DHI.Mike1D.Engine.AddOnsHDMassErrorChecksumCalculator
      DHI.Mike1D.Engine.AddOnsHDWaterMaxVolumeCalculator
      DHI.Mike1D.Engine.AddOnsHDWaterVolumeCalculator
      DHI.Mike1D.Engine.AddOnsHDWaterVolumeInNodesAboveGroundCalculator
      DHI.Mike1D.Engine.AddOnsHDWaterVolumeRetainedInMaxInflowToNodesCalculator
      DHI.Mike1D.Engine.ModuleDataEngineDataItemAllUpdateT