Click or drag to resize

LongTermStatisticsData Class

Class containing the data describing the LTS simulation.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericAbstractDataAccess
    DHI.Mike1D.Mike1DDataAccessLongTermStatisticsData

Namespace:  DHI.Mike1D.Mike1DDataAccess
Assembly:  DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class LongTermStatisticsData : AbstractDataAccess

The LongTermStatisticsData type exposes the following members.

Constructors
  NameDescription
Public methodLongTermStatisticsData
Initializes a new instance of the LongTermStatisticsData class
Top
Properties
  NameDescription
Public propertyConnection
Holder of read/write information
(Inherited from AbstractDataAccess.)
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 propertyDischargeThreshold
Discharge threshold for accumulated event values
Public propertyDryWeatherFlows
Dry Weather Flows reported in result file for LTS simulation.
Public propertyDryWeatherFlowTimeStep
Time step used to evaluate dry weather flow.
Public propertyEpsilonRain
Do not start simulation if it rains less than EpsilonRain ( m3/s / m2 )
Public propertyExtensionData
Holds data from an extended DataContract
(Inherited from AbstractDataAccess.)
Public propertyFailedJobMaxRedoCount
Maximal number of times a failed job is recalculated.
Public propertyFailedJobTimeStepReductionFactor
Reduction factor of a time step after a failed job.
Public propertyGenerateJobListDfs0
Flag specifying also to create a job list file in dfs0 format.
Public propertyGenerateJobListInflowTimeSeries
Flag specifying to create inflow time series used when determining the jobs.
Public propertyGenerateLTSJobList
Determines if the LTS simulation is generating job list.
Public propertyIncludeDtMinMaxInJoblistFile
Include DtMin and DtMax in job list file. Only included so that users can edit the joblist file later and modify for individual events
Public propertyInitialConditions
LTS initial conditions.
Public propertyJobListCreatorType
Job list creator type.
Public propertyJobListFilePath
The job list read from or written to this file
Public propertyJobListTimeStep
Time step for job list generation. Default value is 1 minute.
Public propertyJobRuntimeStopConditionCollections
Runtime stop conditions.
Public propertyJobStartConditions
Job start conditions.
Public propertyJobStopConditions
Job stop conditions.
Public propertyMaxCatchmentDelayTime
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.
Public propertyMinimumTimeBetweenRain
Combine two LTS events if they are less than MinimumTimeBetweenRain apart
Public propertyResultFilePath
LTS results are written to this file
Public propertyResultSpecification Obsolete.
Old LTS result specifications, which are obsoleted.
Public propertyResultSpecifications
Specifications on how to write result files, when, what to include and where.
Public propertyTimeBeforeJobCatchmentDischarge
Simulation time before job for live catchment discharge.
Public propertyTimeBeforeJobNam
Simulation time before job for live NAM catchments.
Public propertyTimeBeforeJobSurface
Simulation time before job for surface model catchments.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInitialCondition
Returns first LTS initial condition which satisfies inflow criteria.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberRead
Read LongTermStatisticsData from an XML file.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validates some LTS data.
Public methodWrite
Write LongTermStatisticsData to an XML file.
Top
Fields
  NameDescription
Protected field_connection
Protected holder of read/write info
(Inherited from AbstractDataAccess.)
Top
See Also