Res1DBridge Class |
[Missing <summary> documentation for "T:DHI.Mike1D.ResultDataAccess.Res1DBridge"]
Inheritance HierarchyNamespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Res1DBridge type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Res1DBridge |
Constructor, storing data in the provided IResultData object.
|
Properties| Name | Description | |
|---|---|---|
 | Connection | (Inherited from Res1DStreamBridge.) |
| DoRewindTime |
Flag indicating whether to rewind outputting if the simulation time
was manually moved back in time. When rewinding, data after the new simulation
time will be overridden by new data.
Default value is true. |
| Filter |
Specifies what data to load. Must be set before
any call to the open and read methods.
(Inherited from Res1DStreamBridge.) |
| NumberOfTimeSteps | Return the number of time steps in the storage (Inherited from Res1DStreamBridge.) |
| SecondsBetweenFileFlush |
Seconds between flush to file. Set this lower if you need to read the result file while your
calculations are running.
(Inherited from Res1DStreamBridge.)Set to zero to disable file flushing. Default value is 10 seconds. |
Methods| Name | Description | |
|---|---|---|
 | CloseDfsFile | (Inherited from Res1DStreamBridge.) |
| Connect |
Connects to storage
(Inherited from Res1DStreamBridge.) |
| CreateDynamicItemInfos | (Inherited from Res1DStreamBridge.) |
| CreateDynamicItemInfosOld | (Inherited from Res1DStreamBridge.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Release ressources allocated by the bridge.
(Inherited from Res1DStreamBridge.) |
| Finish | (Inherited from Res1DStreamBridge.) |
| Flush |
Write the contained time steps into the res11 file
(Inherited from Res1DStreamBridge.) |
| 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 | (Inherited from Res1DStreamBridge.) |
| PeakStaticItemNameNext |
Peak the next static item.
(Inherited from Res1DStreamBridge.) |
| PeakStaticItemNext |
Peak the next static item.
(Inherited from Res1DStreamBridge.) |
| Prepare |
Prepare bridge, create the file, add dynamic and static items.
(Overrides Res1DStreamBridgePrepare(IDiagnostics).) |
| Read |
Reads in the data specified by _specification and _filePath and populates _resultData.
(Inherited from Res1DStreamBridge.) |
| ReadData |
Reads in the data from persistant storage and populates the associated resultdata object.
(Overrides Res1DStreamBridgeReadData(IDiagnostics).)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.
(Inherited from Res1DStreamBridge.) |
| ReadHeader(IDiagnostics, Boolean) | (Inherited from Res1DStreamBridge.) |
| ReadStaticItemNext |
Reads the next static item, depending on the _readMode.
(Inherited from Res1DStreamBridge.) |
| ReadTimeForTimeStep |
Read the first item of the provided time step, and return the time.
|
| ReadTimeStep | Read and populate result data with data for the given time step |
| RewindTime |
If simulation time is changed "back in time", rewind writing
of results, overwriting already written data with new values.
(Overrides Res1DStreamBridgeRewindTime.)Only if [!:] |
| Save |
Writes the content of the _resultDataAccess into a Res1d file
(Inherited from Res1DStreamBridge.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TriggerTimeStepReadEvent |
Method to trigger when a new time step has been read.
(Inherited from Res1DStreamBridge.) |
| Write |
write everything in a file, closing and finalizing file.
(Inherited from Res1DStreamBridge.) |
Events| Name | Description | |
|---|---|---|
 | TimeStepReadEvent |
Event triggered everytime a time step has been read
(Inherited from Res1DStreamBridge.) |
Fields| Name | Description | |
|---|---|---|
 | _connection | (Inherited from Res1DStreamBridge.) |
| _contained |
Table to indicate which items to read. Determined by the filter in ReadDynamicDataHeader()
(Inherited from Res1DStreamBridge.) |
| _dfsFile | (Inherited from Res1DStreamBridge.) |
| _dfsFileStream | (Inherited from Res1DStreamBridge.) |
| _dynamicItems |
List of same size as the dynamic items in the dfs file.
(Inherited from Res1DStreamBridge.) |
| _lastTime |
Last time when the data was outputted.
(Inherited from Res1DStreamBridge.) |
| _predefItemData |
Predefined DFS item data, used when reading, for performance.
(Inherited from Res1DStreamBridge.) |
| _predefItemData0TimestepIndex |
Timestep index of the predefined item data stored in [!:_predefItemData]
for the first item (0 index). This is required to avoid that the first item
is read both in ReadTimeForTimeStep(Int32) and in ReadTimeStep(Int32, Int32).
|
| _resultData | (Inherited from Res1DStreamBridge.) |
| _useUbgUnits | Flag indicating whether file is being read in Ubg user units. Not used when writing (Inherited from Res1DStreamBridge.) |
See Also