Click or drag to resize

Mike1DData Properties

The Mike1DData type exposes the following members.

Properties
  NameDescription
Public propertyADComponentData
Advection-dispersion/component transport data access. Defines components that are included in the simulation.
Public propertyAdditionalData
Additional data, a set of key-value pairs, where the key is a string.
Public propertyBoundaryData
Boundary data access. Provides access to all input data that specifies the boundary conditions
Public propertyCatchmentDischargeResultDataFilePath Obsolete.
Path to file containing rainfall runoff results that is to be coupled with a HD simulation.
Public propertyConnection
Holder of read/write information
(Inherited from AbstractDataAccess.)
Public propertyControlData
Control module data access. Provides access to all input data for control
Public propertyCrossSections
Cross section data access. Provides access to all input data that defines the cross sections.
Public propertyCrossSectionsFilePath
File path to cross section file
Public propertyCustomTypes
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.)
Public propertyDataAssimilationData
Data Assimilation data. Provides access to all input data that specifies Data Assimilation
Public propertyDataVersion
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.
Public propertyDescription
Description of the simulation
Public propertyEcoLabData
EcoLab data access component. Defines the connection between the HD and AD module and the EcoLab template
Public propertyExtensionData
Holds data from an extended DataContract
(Inherited from AbstractDataAccess.)
Public propertyFilePathHtmlErrorLog
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.

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

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

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

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

Public propertyResultSpecifications
Specifications on how to write result files, when, what to include and where.
Public propertyRuntimeDiagnostics
Diagnostics instance for the engine net. Used during runtime.
Public propertyScenarioId
Scenario Id of the simulation
Public propertyScriptInfos
List of scripts registered for this setup.

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

Public propertySimulationEnd
Simulation end time
Public propertySimulationStart
Simulation start time
Public propertyStatestartInfos
List of statestart files, prioritized, the first one being tried first.
Public propertyStateWriteSpecification
Specifications on how to write state files.
Public propertySTData
Sediment Transport data access.
Public propertyTimeStepping
Get/set TimeStepping parameters
Public propertyTsBuffer
A buffer containing all timeseries, so they can be reused.
Public propertyUnitSystem
Unit system used when reporting
Public propertyUseHDLongTermStatistics
If this is true, then run HD simulation in Long Term Statistics mode based on the configuration in
Public propertyUsePipeDesign
Run a pipe design simulation. Pipe design is a MU feature for calibrating reach diameters
Public propertyUserUnitProvider
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.

Top
See Also