IRes1DEnergyPump Interface

Data desription and time step data for a reach (also sometimes called a branch or a link)

Definition

Namespace: DHI.Mike1D.ResultDataAccess.Epanet
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface IRes1DEnergyPump : IRes1DReach, 
	IRes1DDataSet, INetworkReach
Implements
INetworkReach, IRes1DDataSet, IRes1DReach

Properties

AverageCostPerDay 
AverageEfficiency 
AverageKw 
AverageKwMGal 
DataItems List of data items used for accessing the data.
(Inherited from IRes1DDataSet)
DigiPoints List of digi points
(Inherited from IRes1DReach)
DirectionType Direction of positive flow in the reach.
(Inherited from IRes1DReach)
EndNodeIndex Index of the reach end node in the node list
(Inherited from IRes1DReach)
GridPoints List of grid points
(Inherited from IRes1DReach)
Id Identification string
(Inherited from IRes1DDataSet)
IsStructureReach Returns true if the reach is a structure reach (special reach with just one structure q-points and two h-grid points. The h-grid points have very large (unused) cross sections.
(Inherited from IRes1DReach)
Length Return length of reach, chainage-length
(Inherited from IRes1DReach)
LocationSpan Location span that covers this reach.
(Inherited from INetworkReach)
MaximumDx The maximal allowed distance between two points of the same type?
(Inherited from INetworkReach)
Name Name of branch
(Inherited from IRes1DReach)
PeakKw 
ReachListIndex Index into list of nodes, Reaches.

Remarks

When creating a new ResultData object, or modifying an existing, this is not automatically updated. Call ReconnectNetwork to have it updated.

(Inherited from IRes1DReach)
ReverseDirection Reverse the positive flow direction of the reach. Default is false
(Inherited from INetworkReach)
StartNodeIndex Index of the reach start node in the node list
(Inherited from IRes1DReach)
TopoID Id for the cross section topologi that is to be used for the Link / Branch If TopoID is not used, set to empty string (null will be handled as the empty string).
(Inherited from IRes1DReach)
Utilization 

Methods

GetChainages(IDataItem)

Returns the chainages for the elements in the dataitem.

The IDataItem must be a ReachItem and having one vertex per element.


(Inherited from IRes1DReach)
GetChainages(Int32)

Returns the chainages for the elements in the dataitem.

The IDataItem must be a ReachItem and have one vertex per element only.


(Inherited from IRes1DReach)
GetDataItem Return data item of specified type if present, otherwise null
(Inherited from IRes1DDataSet)
GetLowerLimitChainages(IDataItem)

Returns the lower limit chainages for each elements in the dataitem. This is the smallest vertex chainage coordinate for each element.

If an element only has one vertex coordinate, the chainage of the gridpoint before the element gridpoint is returned (lower chainage). At the first gridpoint the chainage of the gridpoint itself is returned.


(Inherited from IRes1DReach)
GetLowerLimitChainages(Int32)

Returns the lower limit chainages for each elements in the dataitem. This is the smallest vertex chainage coordinate for each element.

If an element only has one vertex coordinate, the chainage of the gridpoint after the element gridpoint is returned(lower chainage). At the first gridpoint the chainage of the gridpoint itself is returned.


(Inherited from IRes1DReach)
GetUpperLimitChainages(IDataItem)

Returns the upper limit chainages for each elements in the dataitem. This is the largest vertex chainage coordinate for each element.

If an element only has one vertex coordinate, the chainage of the gridpoint after the element gridpoint is returned (higher chainage). At the last gridpoint the chainage of the gridpoint itself is returned.


(Inherited from IRes1DReach)
GetUpperLimitChainages(Int32)

Returns the upper limit chainages for each elements in the dataitem. This is the largest vertex chainage coordinate for each element.

If an element only has one vertex coordinate, the chainage of the gridpoint after the element gridpoint is returned (higher chainage). At the last gridpoint the chainage of the gridpoint itself is returned.


(Inherited from IRes1DReach)
GridPointIndexForChainage Return index in list of gridpoints for given chainage. Chainage must be within Constants.LOCATION_EQUAL_TOLERANCE of gridpoint chainage, otherwise no grid point is found.
(Inherited from IRes1DReach)

Extension Methods

Diameter Get diameter of reach. It is assumed that the reach uses the same cross section throughout is link. If the reach does not have a circular cross section, null is returned.
(Defined by Res1DExtensions)
EndChainage Extension method return the end chainage of a reach
(Defined by Res1DExtensions)
GetDataItem Return data item of specified type if present, otherwise null
(Defined by Res1DExtensions)
GridpointSearch Extension method searching within the grid points of a reach, using a binary search routine.
(Defined by Res1DExtensions)
LocationSpan Extension method to create a LocationSpan from a reach.
(Defined by Res1DExtensions)
StartChaiange Extension method return the start chainage of a reach
(Defined by Res1DExtensions)
StartChainage Extension method return the start chainage of a reach
(Defined by Res1DExtensions)
UpdateGridPointIndices Update PointIndex.
(Defined by ResultDataExtensions)

See Also