M11FfBridgeBase Class

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

Definition

Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public abstract class M11FfBridgeBase : IResultReadBridge, 
	IResultBridge
Inheritance
Object    M11FfBridgeBase
Derived
Implements
IResultBridge, IResultReadBridge

Constructors

M11FfBridgeBaseInitializes a new instance of the M11FfBridgeBase class

Properties

Connection 
Filter Specifies what data to load
NumberOfTimeSteps Return the number of time steps in the storage
ResultData Result data that values are read into

Methods

Connect Connects to storage
CreateItemTypeData Create an M11FfBridgeBaseItemTypeData from descriptor
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Finish Used to disconnect from/close persistant storage and free resources if needed.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
HandleGlobalUnknownChannel Handle a global unknown type of channel in a generic way
InitializeUnitConversion 
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Read 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.
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 Reads in the header data from persistent storage and populates the associated resultdata object.
ResultTypeToGeometry Translating all PRF result type numbers to a quantity and a geometry that it belongs to. For unknown types, "None" is returned.
SkipBlock Skip reading the current block
ToStringReturns a string that represents the current object.
(Inherited from Object)

Events

TimeStepReadEvent Event triggered everytime a time step has been read

Fields

_blockReader Block reader
_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.
_channelUnitConversion List as long as the number of channels in the prf file. Unit conversion factors for each of them
_connection File name and path
_numTimeSteps Number of time steps in file
_resultData Result data
_simTimeSpan Span of simulation
_timeChannelIndex Index of time channel
_timeDescriptor Time channel descriptor
_timeStep Size of time step
_timeUnitSeconds Seconds in one unit of time. Default is 3600 (hour time unit)
_unitFactorChainage 
_unitFactorDischarge 
_unitFactorLength 
_unitFactorXy 
_unitFactorZ 
_unitProvider Unit provider, null if not enabled
_userUnitDischarge 
CurbRecType CurbRecType
HRecType HRecType
NodeRecType NodeRecType
OrificeRecType OrificeRecType
OrificeRecTypeOld OrificeRecTypeOld
PumpRecType PumpRecType
QRecType QRecType
ValveRecType ValveRecType
VRecType VRecType
WeirRecType WeirRecType

See Also