LongTermStatisticsData Class

Class containing the data describing the LTS simulation.

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

Constructors

LongTermStatisticsDataInitializes a new instance of the LongTermStatisticsData class

Properties

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)
DischargeThreshold Discharge threshold for accumulated event values
DryWeatherFlows Dry Weather Flows reported in result file for LTS simulation.
DryWeatherFlowTimeStep Time step used to evaluate dry weather flow.
EpsilonRain Do not start simulation if it rains less than EpsilonRain.

Unit is different depending on JobListCreatorType: RainSeries: [m/s] AllInflow: [m3/s]

ExtensionData Holds data from an extended DataContract
(Inherited from AbstractDataAccess)
FailedJobMaxRedoCount Maximal number of times a failed job is recalculated.
FailedJobTimeStepReductionFactor Reduction factor of a time step after a failed job.
GenerateJobListDfs0 Flag specifying also to create a job list file in dfs0 format.
GenerateJobListInflowTimeSeries Flag specifying to create inflow time series used when determining the jobs.
GenerateLTSJobList Determines if the LTS simulation is generating job list.
IncludeDtMinMaxInJoblistFile Include DtMin and DtMax in job list file. Only included so that users can edit the joblist file later and modify for individual events
InitialConditions LTS initial conditions.
JobListCreatorType Job list creator type.
JobListFilePath The job list read from or written to this file
JobListTimeStep Time step for job list generation. Default value is 1 minute.
JobRuntimeStopConditionCollections Runtime stop conditions.
JobStartConditions Job start conditions.
JobStopConditions Job stop conditions.
MaxCatchmentDelayTime After that much time it is allowed to jump after a rain event in job list generation. This values should be determined by the maximum delay time of the catchment. Default value is zero.
MinimumTimeBetweenRain Combine two LTS events if they are less than MinimumTimeBetweenRain apart
ResultFilePath LTS results are written to this file
ResultSpecification Old LTS result specifications, which are obsoleted.
Obsolete
ResultSpecifications Specifications on how to write result files, when, what to include and where.
TimeBeforeJobCatchmentDischarge Simulation time before job for live catchment discharge.
TimeBeforeJobNam Simulation time before job for live NAM catchments.
TimeBeforeJobSurface Simulation time before job for surface model catchments.

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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetInitialCondition Returns first LTS initial condition which satisfies inflow criteria.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Read Read LongTermStatisticsData from an XML file.
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validates some LTS data.
Write Write LongTermStatisticsData to an XML file.

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)

See Also