Ascii2Bridge Class |
The Ascii2 bridge is a result data write bridge that is capable
of writing the results of a result data object to an ascii file.
The Ascii2 bridge only stores reach data. All other data items are ignored.
Inheritance HierarchyNamespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Ascii2Bridge type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Ascii2Bridge |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | 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.
(Inherited from AsciiBridge.) |
Methods| Name | Description | |
|---|---|---|
 | DoStore |
Store at this time
(Inherited from AsciiBridge.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows 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.
(Overrides AsciiBridgeFinish.) |
| Flush |
Write the contained time steps into the file
|
| GetFormat |
Get output format of dynamic item
(Inherited from AsciiBridge.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsIncluded |
Returns true if grid point on reach is included in the output.
(Inherited from AsciiBridge.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Prepare | (Inherited from AsciiBridge.) |
| Save |
Writes the content of the _resultDataAccess into file
(Inherited from AsciiBridge.) |
| SetupDynamicItems |
Setup dynamic data: For each output grid point (_dynamicRows), store
a list of dynamic items (columns). The column can be null if that grid point does
not offer that quantity.
(Overrides AsciiBridgeSetupDynamicItems(ListIQuantity, ListInt32).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Truncate(String) |
Truncate string to column width, though only if delimiter is not defined
(Inherited from AsciiBridge.) |
| Truncate(String, Int32) |
Truncate string to length, though only if delimiter is not defined
(Inherited from AsciiBridge.) |
| WriteDashLine |
Write a line of dashes (-) in the txt file, matching numColumns columns of output data
(Inherited from AsciiBridge.) |
| WriteHeader |
Write header of text file - empty, there is a header for each time step.
(Overrides AsciiBridgeWriteHeader.) |
| WriteStaticValue |
Write static value for the staticItem at the reach and grid point index
(Inherited from AsciiBridge.) |
| WriteTimeSteps | (Overrides AsciiBridgeWriteTimeSteps(Boolean).) |
Fields| Name | Description | |
|---|---|---|
 | _columnWidth | Width (minimum) of each column (Inherited from AsciiBridge.) |
| _culture | Culture to use when outputting. Defaults to InvariantCulture (Inherited from AsciiBridge.) |
| _data | Ascii output data (Inherited from AsciiBridge.) |
| _doTruncate | Flag indicating if truncation of string should take place - only when no delimiter is defined (Inherited from AsciiBridge.) |
| _formatChainage | Format string for chainage outputs (Inherited from AsciiBridge.) |
| _formatDefault | Format string for string outputs (Inherited from AsciiBridge.) |
| _formats | Format strings for dynamic and static outputs (Inherited from AsciiBridge.) |
| _maximumTime | Time of maximum value of output quantity (Inherited from AsciiBridge.) |
| _maximumValue | Maximum value of output quantity (Inherited from AsciiBridge.) |
| _minimumTime | Time of minimum value of output quantity (Inherited from AsciiBridge.) |
| _minimumValue | Minimum value of output quantity (Inherited from AsciiBridge.) |
| _resultData | Result data to extract results from (Inherited from AsciiBridge.) |
| _resultSpec | Result specification - storing frequence is used (Inherited from AsciiBridge.) |
| _timeBetweenUpdates | (Inherited from AsciiBridge.) |
| _timeOfNextUpdate | (Inherited from AsciiBridge.) |
| _timestepCount | (Inherited from AsciiBridge.) |
| _writer | (Inherited from AsciiBridge.) |
Remarks
The Ascii2 bridge was added to support the M11 time series output.
See Also