AsciiBridge Class

Common class for ascii bridge data

Definition

Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public abstract class AsciiBridge
Inheritance
Object    AsciiBridge
Derived

Constructors

AsciiBridgeInitializes a new instance of the AsciiBridge class

Properties

SecondsBetweenFileFlush Seconds between flush to file. Set this lower if you need to read the result file while your calculations are running. WARNING: File flush is a potentially expensive operation. Use with care.

Methods

DoStore Store at this time
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)
Finish Finish the file. Write dynamic statistics and static values.
GetFormat Get output format of dynamic item
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsIncluded Returns true if grid point on reach is included in the output.
IsXyStaticItem Returns true if the static item is a (x,y) static item and prints two outputs.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare bridge
ResultDataDoStoreOverride Method to used as the DoStoreUserFunction, to make sure ResultData gets data at every time step (to update statistics)
Save Writes the content of the _resultDataAccess into file
SetupDynamicItems Setup dynamic items
ToStringReturns a string that represents the current object.
(Inherited from Object)
Truncate(String) Truncate string to column width, though only if delimiter is not defined
Truncate(String, Int32) Truncate string to length, though only if delimiter is not defined
WriteDashLine Write a line of dashes (-) in the txt file, matching numColumns columns of output data
WriteHeader Write header, called in end of prepare method
WriteStaticValue Write static value for the staticItem at the reach and grid point index
WriteTimeSteps Write time steps. Called during simulation.

Fields

_columnWidth Width (minimum) of each column
_culture Culture to use when outputting. Defaults to InvariantCulture
_data Ascii output data
_doTruncate Flag indicating if truncation of string should take place - only when no delimiter is defined
_formatChainage Format string for chainage outputs
_formatDefault Format string for string outputs
_formats Format strings for dynamic and static outputs
_itemPredefinedNames Default predefined names for static items
_itemPredefinedNamesYOffset Offset for Y name of static item, for the XY outputs
_maximumTime Time of maximum value of output quantity
_maximumValue Maximum value of output quantity
_minimumTime Time of minimum value of output quantity
_minimumValue Minimum value of output quantity
_resultData Result data to extract results from
_resultSpec Result specification - storing frequency is used
_timeBetweenUpdatesTime between updating - writing to file
_timeOfNextUpdate Time of next update - write-to-file
_timestepCountNumber of time steps written
_writer Writer to write output to

See Also