Res1DStreamBridge Class |
This class supports reading files from a .NET stream.
Namespace: DHI.Mike1D.ResultDataAccess
The Res1DStreamBridge type exposes the following members.
Name | Description | |
---|---|---|
Res1DStreamBridge(IResultData) | Initializes a new instance of the Res1DStreamBridge class | |
Res1DStreamBridge(IResultData, Stream) |
Constructor
|
Name | Description | |
---|---|---|
Connection | ||
Filter |
Specifies what data to load. Must be set before
any call to the open and read methods.
| |
NumberOfTimeSteps | Return the number of time steps in the storage | |
SecondsBetweenFileFlush |
Seconds between flush to file. Set this lower if you need to read the result file while your
calculations are running.
Set to zero to disable file flushing. Default value is 10 seconds. |
Name | Description | |
---|---|---|
CloseDfsFile | ||
Connect |
Connects to storage
| |
CreateDynamicItemInfos | ||
CreateDynamicItemInfosOld | ||
CreateResultDirectory |
Create result directory and check if file already exists that it can be overwritten.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Release ressources allocated by the bridge.
(Overrides ObjectFinalize.) | |
Finish | ||
Flush |
Write the contained time steps into the res11 file
| |
FromDfs | ||
GetFloat |
Get a float from the static item at the given index
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OpenDfsFile | ||
PeakStaticItemNameNext |
Peak the next static item.
| |
PeakStaticItemNext |
Peak the next static item.
| |
Prepare |
Prepare bridge, create the file, add dynamic and static items.
| |
Read |
Reads in the data specified by _specification and _filePath and populates _resultData.
| |
ReadData |
Reads in the data from persistant storage and populates the associated resultdata object.
You can not load the data without having loaded the header, hence it can be assumed that ReadHeader(IDiagnostics) has already been called. | |
ReadHeader(IDiagnostics) |
Reads in the header data from persistant storage and populates the associated resultdata object.
| |
ReadHeader(IDiagnostics, Boolean) | ||
ReadStaticItemNext |
Reads the next static item, depending on the _readMode.
| |
RewindTime |
Override this method to support rewinding of time when running simulation.
This stream version does not support rewinding.
| |
Save |
Writes the content of the _resultDataAccess into a Res1d file
| |
ToDfs | ||
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TriggerTimeStepReadEvent |
Method to trigger when a new time step has been read.
| |
Write |
write everything in a file, closing and finalizing file.
|
Name | Description | |
---|---|---|
TimeStepReadEvent |
Event triggered everytime a time step has been read
|
Name | Description | |
---|---|---|
_connection | ||
_contained |
Table to indicate which items to read. Determined by the filter in ReadDynamicDataHeader()
| |
_dfsFile | ||
_dfsFileStream | ||
_dynamicItems |
List of same size as the dynamic items in the dfs file.
| |
_lastTime |
Last time when the data was outputted.
| |
_predefItemData |
Predefined DFS item data, used when reading, for performance.
| |
_resultData | ||
_useUbgUnits | Flag indicating whether file is being read in Ubg user units. Not used when writing | |
RES1D_VERSION |
Version of the MIKE 1D file format
The integer part is the major version number and the fractional part is the minor version number. If only the minor version number differs, bridge should be backward and forward compatible, forward compatible meaning that older bridge can read newer files, though it will usually miss the new functionality If the major version number differs, bridge will only be backward compatible. |