PrfBridge Class

Bridge for reading MOUSE PRF files.

The bridge can also handle other type of MOUSE result files that has the same structure as PRF file. Some of these PRF-like files are missing the full network definition, and if loaded as a stand-alone file, network is not complete. To get complete network, data must be added to an existing "primary" file, by merging in the data items. Different types of MOUSE results that are supported, are listed below:

PRF: HD primary result output.
PRF: HD result selection output. Must be added to primary PRF file
XRF: HD additional output. Must be added to primary PRF file
TRF: AD data. Should be added to primary PRF file, can load standalone with some definitions missing

Inheritance Hierarchy

SystemObject
DHI.Mike1D.ResultDataAccessM11FfBridgeBase
DHI.Mike1D.ResultDataAccessPrfBridge

Namespace: DHI.Mike1D.ResultDataAccess
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class PrfBridge : M11FfBridgeBase

Public Class PrfBridge
	Inherits M11FfBridgeBase

public ref class PrfBridge : public M11FfBridgeBase

The PrfBridge type exposes the following members.

Constructors

	Name	Description
	PrfBridge	Constructor
	PrfBridge(IResultData)	Constructor. Storing values in provided resultdata object.

Top

Properties

	Name	Description
	Connection	(Inherited from M11FfBridgeBase.)
	Filter	Specifies what data to load (Inherited from M11FfBridgeBase.)
	NumberOfTimeSteps	Return the number of time steps in the storage (Inherited from M11FfBridgeBase.)
	ResultData	Result data that values are read into (Inherited from M11FfBridgeBase.)

Top

Methods

	Name	Description
	Connect	Connects to storage (Inherited from M11FfBridgeBase.)
	CreateItemTypeData	Create an M11FfBridgeBaseItemTypeData from descriptor (Inherited from M11FfBridgeBase.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows 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. (Inherited from M11FfBridgeBase.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HandleGlobalUnknownChannel	Handle a global unknown type of channel in a generic way (Inherited from M11FfBridgeBase.)
	InitializeUnitConversion	(Inherited from M11FfBridgeBase.)
	MemberwiseClone	Creates 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. (Inherited from M11FfBridgeBase.)
	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. (Inherited from M11FfBridgeBase.)
	ReadHeader	Reads in the header data from persistant storage and populates the associated resultdata object. (Overrides M11FfBridgeBaseReadHeader(IDiagnostics).)
	ResultTypeToGeometry	Translating all PRF result type numbers to a quantity and a geometry that it belongs to. For unknown types, "None" is returned. (Overrides M11FfBridgeBaseResultTypeToGeometry(Int32, IQuantity).)
	SkipBlock	Skip reading the current block (Inherited from M11FfBridgeBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	TimeStepReadEvent	Event triggered everytime a time step has been read (Inherited from M11FfBridgeBase.)

Top

Fields

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

Top

Reference

DHI.Mike1D.ResultDataAccess Namespace