Click or drag to resize

StateWriteSpecification Class

Specification for when and how to write state outputs.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Mike1DDataAccessStateWriteSpecification

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

The StateWriteSpecification type exposes the following members.

Constructors
  NameDescription
Public methodStateWriteSpecification
Constructor.
Top
Properties
  NameDescription
Public propertyEndTime
End Time, state will not be outputted after this time

Set to MaxValue to write for the entire simulation period.

Public propertyStartTime
Start Time, first time of state output

Set to MinValue to use start-of-simulation time.

To store one state at a specific time, set the StartTime to the time to store the state, and leave TimeStep to zero.

Public propertyTemplateFilePath
Template file path, used when creating state file names.

Typically it should have the form

Copy
TemplateFilePath.Path = "myFolder\MyStateFileName_{0}.sta1d"
where the placeholder is replaced with the simulation date and time for that state.

If the TemplateFilePath does not contain any placeholder, one is inserted automatically as the last part of the filename.

Public propertyTimeStep
Timespan between writing of states.

Set to zero to disable writing of state on a regular basis.

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 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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also