Click or drag to resize

EngineDataItemAllArray<T> Class

An IEngineDataItem<T> that can contain data for either no or all nodes, and either no or all reaches. Engine data is on the form of EngineDataNode<T> for nodes and EngineDataReach<T> for reaches. These are appropriate for versions of data items storing state, for buffering, for accumulation or similar.

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.

This data item must update it svaleus during UpdateValues(), in which case the UpdateValues() must be overwritten.

Inheritance Hierarchy
System.Object
  DHI.Mike1D.Engine.ModuleData.EngineDataItemAllBase<T>
    DHI.Mike1D.Engine.ModuleData.EngineDataItemAllArray<T>
      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 EngineDataItemAllArray<T> : EngineDataItemAllBase<T>, 
	IEngineDataItem<T>

Type Parameters

T

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

The EngineDataItemAllArray<T> type exposes the following members.

Constructors
Properties
Methods
  NameDescription
Public methodContainsDataGeneric
Check whether there is data for the index reference
(Inherited from EngineDataItemAllBase<T>.)
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 EngineDataItemAllBase<T>.)
Protected methodCreateReachesData
Create ReachesData, usually array of all reaches
(Overrides EngineDataItemAllBase<T>.CreateReachesData(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 EngineDataItemAllBase<T>.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 EngineDataItemAllBase<T>.)
Protected methodSetEngineDataReach
Set reach data to reaches array
(Overrides EngineDataItemAllBase<T>.SetEngineDataReach(Int32, EngineDataReach<T>).)
Public methodSetupDataForNodes(EngineNet)
Setup data for all nodes
Public methodSetupDataForNodes(EngineNet, EngineDataItemAllArray<T>.DCreateNodeData)
Setup data for all nodes
Public methodSetupDataForReaches(EngineNet)
Set up reach data, data on all gridpoints
(Inherited from EngineDataItemAllBase<T>.)
Public methodSetupDataForReaches(EngineNet, EngineDataItemAllArray<T>.DCreateReachData<T>)
Set up reach data, based on delegate
Public methodSetupDataForReaches(EngineNet, Func<EngineReach,Int32[]>)
Set up reach data, based on delegate that returns an indexList
Public methodCode exampleSetupDataForReaches(EngineNet, Predicate<GridPoint>)
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 EngineDataItemAllBase<T>.)
Public methodValueFractionGetter
Public methodValueGetter
Top
Fields
Extension Methods
See Also
Inheritance Hierarchy
System.Object
  DHI.Mike1D.Engine.ModuleData.EngineDataItemAllBase<T>
    DHI.Mike1D.Engine.ModuleData.EngineDataItemAllArray<T>
      DHI.Mike1D.Engine.AddOns.ADDecayAccumulatedCalculator
      DHI.Mike1D.Engine.AddOns.ADMassErrorAccumulatedCalculator
      DHI.Mike1D.Engine.AddOns.HDBedShearStressCalculator
      DHI.Mike1D.Engine.AddOns.HDDischargeStepAveraged
      DHI.Mike1D.Engine.AddOns.HDMassErrorAccumulatedCalculator
      DHI.Mike1D.Engine.AddOns.HDMassErrorCalculator
      DHI.Mike1D.Engine.AddOns.HDWaterFlowRateAboveGroundCalculator
      DHI.Mike1D.Engine.AddOns.HDWaterVolumeChangeCalculator