Click or drag to resize

Mike1DResultDataFactory Class

Factory that sets up an IResultData to retrieve values from an EngineNet
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Mike1DDataAccessMike1DResultDataFactory

Namespace:  DHI.Mike1D.Mike1DDataAccess
Assembly:  DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class Mike1DResultDataFactory

The Mike1DResultDataFactory type exposes the following members.

Constructors
  NameDescription
Public methodMike1DResultDataFactory
Constructor
Top
Properties
  NameDescription
Public propertySkipDataItems
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

Public propertyUserDefinedWriting
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.

Top
Methods
  NameDescription
Public methodStatic memberCreateAdditionalAdOutputSpecification
Helper method for model bridges to set up additional AD output specifications
Public methodStatic memberCreateAdditionalOutputSpecification
Create an additional output specification
Public methodStatic memberCreateADOutputSpecification
Create an AD output specification that matches the baseSpecss
Public methodStatic memberCreateADRROutputSpecification
Create an AD-RR output specification that matches the baseSpecss
Public methodCreateNodeDataItem
Creates a DataItem for a node if the quantity is offered by the node. If the given quantity is not offered, null is returned.
Public methodCreateReachDataItem
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.
Public methodCreateReachDataItemsFromGridPoints
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)

Public methodCreateRes1DDataItem(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.
Public methodCreateRes1DDataItem(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.
Public methodCreateResultData
Create result data object from result specification
Public methodCreateResultDataLTS
Create result data object from result specification for LTS simulation.
Public methodStatic memberCreateSTRROutputSpecification
Create an ST-RR output specification that matches the baseSpecs
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 methodGetHashCode
Serves as the default hash function.
(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 methodStatic memberSetupTimings
Setup timings for resultData object, to report timings together with the post-time-step event timers.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also