RainfallRunoffData Class

Access to catchment data

Definition

Namespace: DHI.Mike1D.RainfallRunoffModule
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class RainfallRunoffData : AbstractDataAccess, 
	IModelStateReadWrite
Inheritance
Object    AbstractDataAccess    RainfallRunoffData
Implements
IModelStateReadWrite

Constructors

RainfallRunoffData Constructor

Properties

AdditionalData Internal method. Additional data from the MIKE 1D data object. Set during initialize.
Catchments Get collection of catchments
Connection Holder of read/write information
(Inherited from AbstractDataAccess)
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)
ExtensionData Holds data from an extended DataContract
(Inherited from AbstractDataAccess)
Parameters Set default parameters for all catchments
Pollutants Get a list of pollutants for SWQ simulation
ProjectionString Projection string, inherited from MIKE 1D Data object.
RuntimeDiagnostics Set the runtime diagnostics. Errors and warnings are added to the runtime diagnostics during rum time.
TimeStepMultiplier For Mike 11 setups, rainfall runoff models use a time step multiplier relative to the HD module time step
WriteRRStatFileFlag If true, then a RRStat.txt file is created with a summary of rainfall runoff data for all catchments. The RRStat.txt file is only created if a stand-alone RR simulation is performed.

Methods

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)
Finish Finish simulation. Calls finish on all cathcments that require finalization.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize(IBoundaryData, IDiagnostics) Initialize rainfall runoff models
Initialize(IBoundaryData, ADComponentData, STData, IDiagnostics) Initialize rainfall runoff models
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare rainfall runoff models
ReadState Read state and apply to module. Returns true if state was successfully read.
ReleaseLicense Release all RR licenses
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validates the object
Validate(IDiagnostics, IBoundaryData) Validates the catchment with boundaries
WriteState Write current state of module

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)
BackwardsCompatible 
DateFormatString String for formatting Date's
DateTimeFormatString String for formatting DateTime's

Extension Methods

Find Find the catchment with the given model ID. Returns null if not found.
(Defined by RRExtensions)
Find Find the first catchment with the given name and offering quantity. Returns null if none found.
(Defined by RRExtensions)
FindAll Get a catchment via its name. Returns null if no catchment has this name.
(Defined by RRExtensions)
FindAll Find all catchments with the specified name, and offering the specified quantity. Returns null if none found.
(Defined by RRExtensions)

See Also