Click or drag to resize

Mike1DStateWriter Class

Class for writing current state of a MIKE 1D model to a state file.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Mike1DDataAccessMike1DStateWriter

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 Mike1DStateWriter

The Mike1DStateWriter type exposes the following members.

Constructors
  NameDescription
Public methodMike1DStateWriter
Create state writer class
Top
Properties
  NameDescription
Public propertyFileTimeFormat
Format of time string in file name. Must not include characters that are not valid for a file-name, especially colon, i.e. "HH:mm:ss" is not allowed.

Default is "yyyyMMddTHHmmss" (ISO 8601 basic format)

Public propertyStateTime
Last time the state was written. This may be differ from time series
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 methodPostTimeStep
This methods checks if it is now the time to write state, and if so, writes it
Public methodPrepare
Preparing state writing
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteState
Write state to state file
Top
Fields
  NameDescription
Public fieldCustomStateWriters
List of custom state writers.

This works in par with the CustomStateReaders, such that it is possible to write and read custom state into the MIKE 1D state file.

Public fieldStatic memberDefaultFileTimeFormat
Default formatting of date and time in file name
Top
See Also