StateWriteSpecification Class

Specification for when and how to write state outputs.

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 StateWriteSpecification
Inheritance
Object    StateWriteSpecification

Constructors

Properties

EndTime End Time, state will not be outputted after this time

Set to MaxValue to write for the entire simulation period.

StartTime 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.

TemplateFilePath Template file path, used when creating state file names.

Typically it should have the form 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.

TimeStep Timespan between writing of states.

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

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)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also