Mike1DData Class

Create a new Mike1DData component

Advection-dispersion/component transport data access. Defines components that are included in the simulation.

Additional data, a set of key-value pairs, where the key is a string.

Boundary data access. Provides access to all input data that specifies the boundary conditions

Path to file containing rainfall runoff results that is to be coupled with a HD simulation.

Holder of read/write information

Control module data access. Provides access to all input data for control

Cross section data access. Provides access to all input data that defines the cross sections.

File path to cross section file

List of custom types stored in the data object and that must be serialized.

A custom type is e.g. a user implemented structure or catchment model. In order to store information on the custom type in the .m1dx file, the system needs to know which custom types are being used, and they must be added to this list.

Data Assimilation data. Provides access to all input data that specifies Data Assimilation

Version of data read from storage. Only applicable when reading data from .m1dx file, where it is possible to check if data is read from an older .m1dx file.

Description of the simulation

EcoLab data access component. Defines the connection between the HD and AD module and the EcoLab template

Holds data from an extended DataContract

File path of html error log. Used by SimLauncher.SimulationWorker to create the log.

The log files will not be created when using the IMike1DController directly.

File path of html summary. Used in SimLauncher.SimulationWorker to create the log.

The log files will not be created when using the IMike1DController directly.

HD parameter data access. Provides options for the HD part of the engine

Id of the simulation

Data access for HD long term statistics simulations

Maximum number of backups of html error log file. Log files are rolled over so that older log files are kept. This is the maximum number of old log files that are stored. Default value is 3.

Network data access. Provides access to input data that defines the network. Notice that structure data are accessed through the the network.

Pipe design data. Pipe design is a MU feature for calibrating reach diameters

List of plugins registered for this setup.

Plugins are handled when the setup has been loaded and a Mike1DData object is available.

A WKT string defining the spatial reference system. See DHI.Generic.DFSIO.IDFSProjection for details.

Rainfall Runoff (catchment) data access. Provides access to all input data that specifies rainfall runoff models

Path to file containing rainfall runoff results that is to be coupled with a HD simulation.

Base path for result files. If a relative path is specified for a result file, the path is relative to this path.

If this is not set explicitly, the Connection FilePath is used as base file path. Set to null to delete an explicitly defined value.

If folder does not exist, but the parent folder exists, the folder will be created when the simulation is executed.

Specifications on how to write result files, when, what to include and where.

Diagnostics instance for the engine net. Used during runtime.

Scenario Id of the simulation

List of scripts registered for this setup.

Scripts are handled when the setup has been loaded and a Mike1DData object is available.

Simulation end time

Simulation start time

List of statestart files, prioritized, the first one being tried first.

Specifications on how to write state files.

Sediment Transport data access.

Get/set TimeStepping parameters

A buffer containing all timeseries, so they can be reused.

Unit system used when reporting

If this is true, then run HD simulation in Long Term Statistics mode based on the configuration in

Run a pipe design simulation. Pipe design is a MU feature for calibrating reach diameters

Unit provider used when UnitSystem is User

You must also set the UnitSystem to User in order to use the specified unit provider.

The user unit provider must be set in-process, i.e. it is not stored to MIKE 1D setup file.

Returns true if data is associated with the key.

Create a runtime Diagnostics instance. This is called from Mike1DController.Prepare()

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Get additional data, based on key.

Get additional data, based on key. If no data exist for value, return the defaultValue

Creates a default result specification of the type provided.

Serves as the default hash function.

Gets the Type of the current instance.

Static method for explicitly loading of a MIKE 1D plugin.

Creates a shallow copy of the current Object.

Set additional data

Returns a string that represents the current object.

Get additional data, based on key.

Validates the contents. Files are validated for existence. Large parts of the validations are delegated to the included data access modules.

Protected holder of read/write info

Event that is triggered when a this Mike1DData is being connected to a newly created controller.

This can be used by components that only have access to data access classes, to also get access to the controller and its events. Examples are data bridges and plugins.

Flag specifying whether Advection Dispersion/component transport is included.

Flag specifying whether rainfall runoff catchment discharge data are extracted from a rainfall runoff result file. Can not be used simultaneously with the UseRR, only one of them can be enabled.

Flag specifying whether Control module is included.

Flag specifying whether DA is included.

Flag specifying whether EcoLab is included. EcoLab automatically enables AD, UseAD

Flag specifying whether HD is included.

Flag specifying whether Rainfall Runoff calculation is included.

Flag specifying whether water quality (from AD or ST) for RR is included.

Flag specifying whether rainfall runoff data are extracted from a rainfall runoff result file. Can not be used simultaneously with the UseRR, only one of them can be enabled.

Flag specifying whether Sediment transport is included.

Modifies MUP result specifications to better match the default MU result specifications.

Get unit provider, matching the UnitSystem.

Bool indicating if RR results are active in the HD simulation.

RR results can contain Runoff or Catchment Discharge results, or both.