Click or drag to resize

Dfs0Bridge Class

The Dfs0 bridge is a result data write bridge that is capable of writing the results of a result data object to a dfs0 file.

The Dfs0 bridge only stores reach data. All other data items are ignored.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.ResultDataAccessDfs0Bridge

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

The Dfs0Bridge type exposes the following members.

Constructors
  NameDescription
Public methodDfs0Bridge
Constructor
Top
Properties
  NameDescription
Public propertyConnection
Public propertyDoRewindTime
Flag indicating whether to rewind time step index if the outputting time was moved before the last outputted time.
Public propertyFilter
Public propertyNumberOfTimeSteps
Return the number of time steps in the storage
Public propertySecondsBetweenFileFlush
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.
Top
Methods
  NameDescription
Public methodConnect
Connects to storage
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFinish
Used to disconnect from/close persistant storage and free resources if needed.
Public methodFlush
Write the contained time steps into the file
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare the persistant storage for flush operations.
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.
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.

Public methodReadHeader
Reads in the header data from persistant storage and populates the associated resultdata object.
Public methodReadTimeForTimeStep
Return the time for the given time step
Public methodReadTimeStep
Read and populate result data with data for the given time step
Public methodSave
Writes the content of the _resultDataAccess into a Dfs0 file
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
write everything in a file, closing and finalizing file.
Top
Events
  NameDescription
Public eventTimeStepReadEvent
Event triggered everytime a time step has been read
Top
Remarks
The Dfs0 bridge was added to support the M11 time series output.
See Also