Mike1DData Class

Class that collects all DataAccess components in one place.

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 Mike1DData : AbstractDataAccess
Inheritance
Object    AbstractDataAccess    Mike1DData

Constructors

Mike1DData Create a new Mike1DData component

Properties

ADComponentData Advection-dispersion/component transport data access. Defines components that are included in the simulation.
AdditionalData Additional data, a set of key-value pairs, where the key is a string.
AirData Air parameter data access.
BoundaryData Boundary data access. Provides access to all input data that specifies the boundary conditions
CatchmentDischargeResultDataFilePath Path to file containing rainfall runoff results that is to be coupled with a HD simulation.
Obsolete
Connection Holder of read/write information
(Inherited from AbstractDataAccess)
ControlData Control module data access. Provides access to all input data for control
CrossSections Cross section data access. Provides access to all input data that defines the cross sections.
CrossSectionsFilePath File path to cross section file
CustomTypes 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.


(Inherited from AbstractDataAccess)
DataAssimilationData Data Assimilation data. Provides access to all input data that specifies Data Assimilation
DataVersion 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 Description of the simulation
EcoLabData EcoLab data access component. Defines the connection between the HD and AD module and the EcoLab template
ExtensionData Holds data from an extended DataContract
(Inherited from AbstractDataAccess)
FilePathHtmlErrorLog 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.

FilePathHtmlSummary 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.

HDParameters HD parameter data access. Provides options for the HD part of the engine
Id Id of the simulation
LongTermStatistics Data access for HD long term statistics simulations
MaxNumberOfErrorLogFileBackups 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 Network data access. Provides access to input data that defines the network. Notice that structure data are accessed through the the network.
PipeDesignData Pipe design data. Pipe design is a MU feature for calibrating reach diameters
PluginInfos List of plugins registered for this setup.

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

ProjectionString A WKT string defining the spatial reference system. See DHI.Generic.DFSIO.IDFSProjection for details.
RainfallRunoffData Rainfall Runoff (catchment) data access. Provides access to all input data that specifies rainfall runoff models
RainfallRunoffResultDataFilePath Path to file containing rainfall runoff results that is to be coupled with a HD simulation.
Obsolete
ResultBaseFilePath 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.

ResultSpecifications Specifications on how to write result files, when, what to include and where.
RuntimeDiagnostics Diagnostics instance for the engine net. Used during runtime.
ScenarioId Scenario Id of the simulation
ScriptInfos List of scripts registered for this setup.

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

SimulationEnd Simulation end time
SimulationStart Simulation start time
StatestartInfos List of statestart files, prioritized, the first one being tried first.
StateWriteSpecification Specifications on how to write state files.
STData Sediment Transport data access.
TimeStepping Get/set TimeStepping parameters
TsBuffer A buffer containing all timeseries, so they can be reused.
UnitSystem Unit system used when reporting
UseHDLongTermStatistics If this is true, then run HD simulation in Long Term Statistics mode based on the configuration in
UsePipeDesign Run a pipe design simulation. Pipe design is a MU feature for calibrating reach diameters
UserUnitProvider 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.

Methods

ContainsAdditionalData Returns true if data is associated with the key.
Create Create a new Mike1DData object from a file
CreateRuntimeDiagnostics Create a runtime Diagnostics instance. This is called from Mike1DController.Prepare()
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)
GetAdditionalData(String) Get additional data, based on key.
GetAdditionalDataT(String, T) Get additional data, based on key. If no data exist for value, return the defaultValue
GetDefaultResultSpecification Creates a default result specification of the type provided.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
LoadPlugin Static method for explicitly loading of a MIKE 1D plugin.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Save Save a Mike1DData object to an m1dx file
SetAdditionalData Set additional data
SetOrUpdateAdditionalData Set or update additional data.
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryGetAdditionalData Get additional data, based on key.
Validate Validates the contents. Files are validated for existence. Large parts of the validations are delegated to the included data access modules.

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)
ControllerCreatedEvent 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.

UseAD Flag specifying whether Advection Dispersion/component transport is included.
UseAir Flag specifying whether air module is included.
UseCatchmentDischargeResults 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.
Obsolete
UseControlModule Flag specifying whether Control module is included.
UseDA Flag specifying whether DA is included.
UseEL Flag specifying whether EcoLab is included. EcoLab automatically enables AD, UseAD
UseHD Flag specifying whether HD is included.
UseRR Flag specifying whether Rainfall Runoff calculation is included.
UseRRADST Flag specifying whether water quality (from AD or ST) for RR is included.
UseRRResults 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.
Obsolete
UseST Flag specifying whether Sediment transport is included.

Extension Methods

AddEnergyEquationStructureOutputs Adds structure additional outputs.
(Defined by Mike1DDataExtensions)
SetMikeHydroToMikePlusCrossSections Reuses MIKE Hydro cross sections in MIKE+ for regression tests.
(Defined by Mike1DDataExtensions)
SetMikeHydroToMikePlusDataOrder Reuses MIKE Hydro cross sections in MIKE+ for regression tests.
(Defined by Mike1DDataExtensions)
SetMikeHydroToMikePlusRegressionTestCompatibilityMode Reuses MIKE Hydro regression test result specification in MIKE+ for regression tests.
(Defined by Mike1DDataExtensions)
SetMikeUrbanClassicToMikePlusRegressionTestCompatibilityMode Modifies MIKE+ result specifications to better match the default MIKE Urban Classic result specifications.
(Defined by Mike1DDataExtensions)
UnitProvider Get unit provider, matching the UnitSystem.
(Defined by Mike1DDataExtensions)
UseRRResults Bool indicating if RR results are active in the HD simulation.

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


(Defined by Mike1DDataExtensions)

See Also