ResultSpecification Class

Specification for writing results: File to output to, time to output, what to output (quantities), and where (spatially) to include output.

Definition

Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class ResultSpecification
Inheritance
Object    ResultSpecification

Constructors

ResultSpecification Default constructor

Properties

Connection Connection of where and how to store the file
DefaultFilter Default filter
Description Description of specification
EndTime End Time for user result selection

Set to MinValue to disable

ID ID of specification
Interpolate Flag specifying if to interpolate when result storing frequence does not match time steps of the simulation
Mode Mode of which to open file. If file does not exist, the file will always be created. Default is to overwrite
StartTime Start Time for user result selection

Set to MinValue to disable

StoringFrequency Storing frequence. Default value: 1
StoringFrequencyType Storing frequence type
What List of what to store - which datatypes

Methods

CalculateStoringFrequencySpan Calculate a storingFrequency TimeSpan based on StoringFrequencyType and StoringFrequency
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)
GetFilter Getting IRes1DSpatialFilter
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetStoringFrequencySpan Calculate a storingFrequency TimeSpan based on StoringFrequencyType and StoringFrequency
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetFilter Setting IRes1DSpatialFilter
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)

Fields

ResultType Result type

Extension Methods

SaveHD Returns true if result is HD type
(Defined by ResultDataExtensions)
SaveRR Returns true if result is rainfall-runoff type
(Defined by ResultDataExtensions)
WhatAddUnique Adds the quantity to the What, if it is not already there
(Defined by ResultDataExtensions)

See Also