Click or drag to resize

HotstartInfo Class

Structure to store hotstart information.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericHotstartInfo

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HotstartInfo

The HotstartInfo type exposes the following members.

Constructors
  NameDescription
Public methodHotstartInfo(IFilePath)
Create new HotstartInfo based on the filename
Public methodHotstartInfo(IFilePath, DateTime)
Create new HotstartInfo based on the filename and time to look up in the hotstart file
Top
Properties
  NameDescription
Public propertyConnection
Connection info of file to load hotstart from
Public propertyFileName
Name of file to load hotstart from, short of
Connection.FileName
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
Fields
  NameDescription
Public fieldExtrapolationDistance
Distance from gridpoint where extrapolation takes place, i.e., if location chainage is outside the hotstart file, but less than ExtrapolationDistance from the nearest value in the hotstart file, then the nearest value is extrapolated. Set to 0 to disable. Default is LOCATION_EQUAL_TOLERANCE. Can not be negative.
Public fieldTime
Time to use when extracting hotstart values from hotstart file. Set to MinValue, if hotstart time should equal simulation start time.
Top
See Also