Click or drag to resize

DHI.Mike1D.Engine.ModuleData Namespace

Data Module. Used for additional output and various processing while the engine is running.
Classes
  ClassDescription
Public classAbstractEngineDataGeneric
Abstract class for storing generic engine data.
Public classAbstractEngineDataNode<T>
Abstract class for supporting Pull version of calculating node data. Data is calculated when GetValues are called.
Public classAbstractEngineDataReach<T>
Abstract class for supporting Pull version of calculating reach data. Data is calculated when GetValues are called.
Public classDataModule

The DataModule contains a set of IEngineDataItem with each their IQuantity.

It implements the IModule interface, however, it has no timestepping functionality.

Public classDataModuleExtensions
Public classEngineData<T>
Base implementation of IEngineData, storing data in the Values array
Public classEngineDataGeneric<T>
Public classEngineDataItemAll<T>
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 IEngineDataNode<T> for nodes and IEngineDataReach<T> for reaches. These are appropriate for pull-versions of data items, adding user implementations of the two interfaces.

The AbstractEngineDataNode<T> and AbstractEngineDataReach<T> 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.

Public classEngineDataItemAllArray<T>
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.

Public classEngineDataItemAllBase<T>
An IEngineDataItem<T> base class that contains generic data and base functionality.

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.

Public classEngineDataItemAllUpdate<T>
A version of the EngineDataItemAll<T> based on objects that does the actual update.

This can be utilized for reach/node engine data that can update them selves, by having the engine data class implement the IUpdatable and register it using the RegisterUpdater(IUpdatable) method.

Public classEngineDataNode<T>
Base implementation of IEngineData, storing data in Value
Public classEngineDataReach<T>
Interfaces
  InterfaceDescription
Public interfaceIEngineData<T>
Interface for a set of engine data
Public interfaceIEngineDataGeneric<T>
Interface for a set of engine data that matches a given IElementSetDefinition
Public interfaceIEngineDataItem<T>

An IEngineDataItem<T> contains data for one quantity.

Data can be present on a node, on a set of gridpoints of a reach, as general data on a reach, and as general data.

Public interfaceIEngineDataNode<T>
Interface for engine data on a node.
Public interfaceIEngineDataReach<T>
Interface for a set of engine data that belongs to a set of gridpoints in a reach
Public interfaceIUpdatable
Interface for an updatable object.
Delegates
  DelegateDescription
Public delegateEngineDataItemAll<T>.DCreateNodeData<TT>
Delete which creates data on the reach
Public delegateEngineDataItemAll<T>.DCreateReachData<TT>
Delete which creates data on the reach
Public delegateEngineDataItemAllArray<T>.DCreateNodeData
Delete which creates data on the reach
Public delegateEngineDataItemAllArray<T>.DCreateReachData<TT>
Delete which creates data on the reach