Mike1DResultDataFactory Class

Factory that sets up an IResultData to retrieve values from an EngineNet

Definition

Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class Mike1DResultDataFactory
Inheritance
Object    Mike1DResultDataFactory

Constructors

Properties

SkipDataItems Flag indicating if to skip creating data items automatically from engine. If set, the user must define data items themselves, and also assure that data is populated automatically.

Default: false

UserDefinedWriting Flag indicating if the user handles flushing to file manually. If set, the user must manually write data to file.

Default: false, meaning that writing to file is handled automatically by the engine.

Methods

CreateAdditionalAdOutputSpecification Helper method for model bridges to set up additional AD output specifications
CreateAdditionalOutputSpecification Create an additional output specification
CreateADOutputSpecification Create an AD output specification that matches the baseSpecss
CreateADRROutputSpecification Create an AD-RR output specification that matches the baseSpecss
CreateNodeDataItem Creates a DataItem for a node if the quantity is offered by the node. If the given quantity is not offered, null is returned.
CreateReachDataItem Creates a DataItem for a reach if the quantity is offered as an item global to the reach. If the given quantity is not offered, null is returned.
CreateReachDataItemsFromGridPoints Creates a DataItem for all grid points in a reach. If no gridpoints offer the given quantity, null is returned.

The method returns a list of data items, since the same quantity may occur more than once on a grid point (e.g. structure discharges if there are paralle structures (more than one structure at the same location)

CreateRes1DDataItem(ResultData, ResultSpecification, EngineNet, IQuantity, IProxyProvider) Create data item in results for the quantity extracting values from the module. The data items are stored in the results object.
CreateRes1DDataItem(ResultData, ResultSpecification, EngineNet, IQuantity, IProxyProvider, IRes1DSpatialFilter) Create data item in results for the quantity extracting values from the module. The data items are stored in the results object.
CreateResultData Create result data object from result specification
CreateResultDataLTS Create result data object from result specification for LTS simulation.
CreateSTRROutputSpecification Create an ST-RR output specification that matches the baseSpecs
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetupFullRunningDischarge Setup full running discharge NetWorkData
SetupTimings Setup timings for resultData object, to report timings together with the post-time-step event timers.
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also