Click or drag to resize

IResultReadWriteBridge Interface

Interface that is to be implemted for a bridge that can read and write between the ResultData access and persistant storage. For detail, see the IResultReadBridge and IResultWriteBridge.

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface IResultReadWriteBridge : IResultReadBridge, 
	IResultBridge, IResultWriteBridge

The IResultReadWriteBridge type exposes the following members.

Properties
  NameDescription
Public propertyConnection
Connection specifying the file to read from
(Inherited from IResultReadBridge.)
Public propertyFilter
Specifies what data to load. Must be set before any call to the open and read methods.
(Inherited from IResultReadBridge.)
Public propertyNumberOfTimeSteps
Return the number of time steps in the storage
(Inherited from IResultReadBridge.)
Public propertySecondsBetweenFileFlush
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.

WARNING: File flush is a potentially expensive operation. Use with care.

(Inherited from IResultWriteBridge.)
Top
Methods
  NameDescription
Public methodConnect
Connects to storage
(Inherited from IResultReadBridge.)
Public methodFinish
Used to disconnect from/close persistant storage and free resources if needed.
(Inherited from IResultBridge.)
Public methodFlush
Flush must store data from result data (memory) and into persistant storage (file or database)
(Inherited from IResultWriteBridge.)
Public methodPrepare
Prepare the persistant storage for flush operations.
(Inherited from IResultWriteBridge.)
Public methodRead
Reads the header and data from persistant storage and populates the associated resultData object. This is the same as calling ReadHeader(IDiagnostics) and ReadData(IDiagnostics) in that order.
(Inherited from IResultReadBridge.)
Public methodReadData
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.

(Inherited from IResultReadBridge.)
Public methodReadHeader
Reads in the header data from persistant storage and populates the associated resultdata object.
(Inherited from IResultReadBridge.)
Public methodSave
Writes the entire content of the result data into a persistent storage
(Inherited from IResultWriteBridge.)
Top
Events
  NameDescription
Public eventTimeStepReadEvent
Event triggered everytime a time step has been read
(Inherited from IResultReadBridge.)
Top
See Also