Click or drag to resize

StateWriteSpecification Properties

The StateWriteSpecification type exposes the following members.

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
See Also