Click or drag to resize

M11FfBridgeBase Class

Base class for a bridge reading files in the old MIKE 11 File Format
Inheritance Hierarchy

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

The M11FfBridgeBase type exposes the following members.

Constructors
  NameDescription
Protected methodM11FfBridgeBase
Initializes a new instance of the M11FfBridgeBase class
Top
Properties
  NameDescription
Public propertyConnection
Public propertyFilter
Specifies what data to load
Public propertyNumberOfTimeSteps
Return the number of time steps in the storage
Public propertyResultData
Result data that values are read into
Top
Methods
  NameDescription
Public methodConnect
Connects to storage
Protected methodCreateItemTypeData
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleGlobalUnknownChannel
Handle a global unknown type of channel in a generic way
Protected methodInitializeUnitConversion
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.
Protected methodResultTypeToGeometry
Translating all PRF result type numbers to a quantity and a geometry that it belongs to. For unknown types, "None" is returned.
Protected methodSkipBlock
Skip reading the current block
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventTimeStepReadEvent
Event triggered everytime a time step has been read
Top
Fields
  NameDescription
Protected field_blockReader
Block reader
Protected field_channelDataItemIndices
List as long as the number of channels in the prf file. For each channel it specifies which data item and index that the channel values should be stored in. Null if channel is to be disregarded.
Protected field_channelUnitConversion
List as long as the number of channels in the prf file. Unit conversion factors for each of them
Protected field_connection
File name and path
Protected field_numTimeSteps
Number of time steps in file
Protected field_resultData
Result data
Protected field_simTimeSpan
Span of simulation
Protected field_timeChannelIndex
Index of time channel
Protected field_timeDescriptor
Time channel descriptor
Protected field_timeStep
Size of time step
Protected field_timeUnitSeconds
Seconds in one unit of time. Default is 3600 (hour time unit)
Protected field_unitFactorChainage
Protected field_unitFactorDischarge
Protected field_unitFactorLength
Protected field_unitFactorXy
Protected field_unitFactorZ
Protected field_unitProvider
Unit provider, null if not enabled
Protected field_userUnitDischarge
Protected fieldStatic memberCurbRecType
CurbRecType
Protected fieldStatic memberHRecType
HRecType
Protected fieldStatic memberNodeRecType
NodeRecType
Protected fieldStatic memberOrificeRecType
OrificeRecType
Protected fieldStatic memberOrificeRecTypeOld
OrificeRecTypeOld
Protected fieldStatic memberPumpRecType
PumpRecType
Protected fieldStatic memberQRecType
QRecType
Protected fieldStatic memberValveRecType
ValveRecType
Protected fieldStatic memberVRecType
VRecType
Protected fieldStatic memberWeirRecType
WeirRecType
Top
See Also