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.

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, in which case the UpdateValues must be overwritten. An alternative is to use the EngineDataItemAllUpdateT, where a number of update methods can be registered.

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

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 EngineDataItemAll<T> : IEngineDataItem<T>

Type Parameters

T

The EngineDataItemAllT type exposes the following members.

Constructors
Properties
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 methodContainsDataReachGeneric
Check whether there is generic 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 methodGetDataReachGeneric
Get generic engine data for the specified reach.
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(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
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 methodCode exampleSetupDataForReaches(EngineNet, ListInt32, ListDouble, ListDouble, PredicateGridPoint)
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
Top
Fields
  NameDescription
Public fieldGenericData
Generic data
Public fieldNodesData
Data on nodes
Public fieldReachesData
Data on reaches
Public fieldReachGenericData
Generic data on reaches
Top
See Also
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineDataItemAllT
    DHI.Mike1D.Engine.AddOnsADDecayAccumulatedCalculator
    DHI.Mike1D.Engine.AddOnsADMassErrorAccumulatedCalculator
    DHI.Mike1D.Engine.AddOnsHDDischargeStepAveraged
    DHI.Mike1D.Engine.AddOnsHDFloodedArea
    DHI.Mike1D.Engine.AddOnsHDInOutFlowCalculator
    DHI.Mike1D.Engine.AddOnsHDMassErrorAccumulatedCalculator
    DHI.Mike1D.Engine.AddOnsHDMassErrorAccumulatedChecksumCalculator
    DHI.Mike1D.Engine.AddOnsHDMassErrorCalculator
    DHI.Mike1D.Engine.AddOnsHDMassErrorChecksumCalculator
    DHI.Mike1D.Engine.AddOnsHDWaterMaxVolumeCalculator
    DHI.Mike1D.Engine.AddOnsHDWaterVolumeCalculator
    DHI.Mike1D.Engine.AddOnsHDWaterVolumeChangeCalculator
    DHI.Mike1D.Engine.AddOnsHDWaterVolumeInNodesAboveGroundCalculator
    DHI.Mike1D.Engine.AddOnsHDWaterVolumeRetainedInMaxInflowToNodesCalculator
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllDouble
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllUpdateT