HDInOutFlowCalculator Class

Helper class providing the inflow to the network.

This is a lazy/pull driven version, only retrieving values when required. If the same values are retrieved more than once, they are recalculated from scratch.

Inheritance Hierarchy

SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineDataItemAllBaseDouble
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllDouble
      DHI.Mike1D.Engine.AddOnsHDInOutFlowCalculator

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

Syntax

C++

Copy

public class HDInOutFlowCalculator : EngineDataItemAll<double>

Public Class HDInOutFlowCalculator
	Inherits EngineDataItemAll(Of Double)

public ref class HDInOutFlowCalculator : public EngineDataItemAll<double>

The HDInOutFlowCalculator type exposes the following members.

Properties

	Name	Description
	DataGeneric	Get engine data for the specified index reference. (Inherited from EngineDataItemAllBaseT.)
	IsLazy	Flag indicating if data item should apply lazy evaluation (Inherited from EngineDataItemAllT.)
	Quantity	Quantity of the data in this IEngineDataItemT (Inherited from EngineDataItemAllBaseT.)

Top

Methods

	Name	Description
	ContainsDataGeneric	Check whether there is data for the index reference (Inherited from EngineDataItemAllBaseT.)
	ContainsDataNode	Check whether there is data for the specified node (Inherited from EngineDataItemAllT.)
	ContainsDataReach	Check whether there is data for the specified reach (Inherited from EngineDataItemAllT.)
	ContainsDataReachGeneric	Check whether there is generic data for the specified reach (Inherited from EngineDataItemAllBaseT.)
	Create	Create an engine data item that provides in/outflow into/from the model. It can produce the general in/out flow and also detailed in/out flow of all nodes/reaches/gridpoints. Set the detailed to true to get detailed results.
	CreateGridPointMap	For every reach, create a mapping from grid point index in reach to grid point index in enginedata item. (Inherited from EngineDataItemAllT.)
	CreateReachesData	Create ReachesData, usually array of all reaches (Inherited from EngineDataItemAllT.)
	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.)
	GetDataReach	Get engine data for the specified reach. (Inherited from EngineDataItemAllT.)
	GetDataReachGeneric	Get generic engine data for the specified reach. (Inherited from EngineDataItemAllBaseT.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNodeData	Get engine data for the specified node. (Inherited from EngineDataItemAllT.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Get engine data for the specified node. (Inherited from EngineDataItemAllT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	(Inherited from EngineDataItemAllBaseT.)
	SetEngineDataReach	Set reach data to reaches array (Inherited from EngineDataItemAllT.)
	SetupDataForNodes(EngineNet)	Setup data for all nodes (Inherited from EngineDataItemAllT.)
	SetupDataForNodes(EngineNet, EngineDataItemAllTDCreateNodeDataT)	Setup data for all nodes (Inherited from EngineDataItemAllT.)
	SetupDataForReaches(EngineNet)	Set up reach data, data on all gridpoints (Inherited from EngineDataItemAllBaseT.)
	SetupDataForReaches(EngineNet, EngineDataItemAllTDCreateReachDataT)	Set up reach data, based on delegate (Inherited from EngineDataItemAllT.)
	SetupDataForReaches(EngineNet, PredicateGridPoint)	Set up reach data, data on all gridpoints of a given instance type (Inherited from EngineDataItemAllT.)
	SetupDataForReaches(EngineNet, Type)	Set up reach data, data on all gridpoints of a given instance type (Inherited from EngineDataItemAllT.)
	SetupDetailed	Enable detailed calculations, for all nodes and grid points in the network
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateValues	Update values of all pull items (Inherited from EngineDataItemAllBaseT.)
	ValueFractionGetter	Valuegetter for engine data for the specified node. (Inherited from EngineDataItemAllT.)
	ValueGetter	Valuegetter for engine data for the specified node. (Inherited from EngineDataItemAllT.)

Top

Fields

	Name	Description
	_engineNet	EngineNet variable (Inherited from EngineDataItemAllT.)
	GenericData	Generic data (Inherited from EngineDataItemAllBaseT.)
	NodesData	Data on nodes. Null if no data on nodes (Inherited from EngineDataItemAllT.)
	ReachesData	Data on reaches. Null if no data on reaches (Inherited from EngineDataItemAllT.)
	ReachGenericData	Generic data on reaches (Inherited from EngineDataItemAllBaseT.)

Top

Reference

DHI.Mike1D.Engine.AddOns Namespace