Res1DSwmmReach Class

Data desription and time step data for a reach that only contains a structure

Definition

Namespace: DHI.Mike1D.ResultDataAccess.Swmm
Assembly: DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class Res1DSwmmReach : Res1DReach, 
	IRes1DSwmmReach, IRes1DStructureReach, IRes1DReach, IRes1DDataSet, INetworkReach
Inheritance
Object    Res1DAbstractDataSet    Res1DReach    Res1DSwmmReach
Implements
INetworkReach, IRes1DDataSet, IRes1DReach, IRes1DStructureReach, IRes1DSwmmReach

Constructors

Res1DSwmmReachInitializes a new instance of the Res1DSwmmReach class

Properties

DataItems List of data items used for accessing the data.
(Inherited from Res1DAbstractDataSet)
Diameter Return diameter
DigiPoints List of digi points
(Inherited from Res1DReach)
DirectionType Direction for the gridpoint. ???
(Inherited from Res1DReach)
EndNodeIndex Reference to the end node
(Inherited from Res1DReach)
GridPoints List of grid points
(Inherited from Res1DReach)
Id Identification string
(Inherited from Res1DAbstractDataSet)
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 Res1DReach)
Length Default implementation of IRes1DReach
LocationSpan Location span that covers this reach.
(Inherited from Res1DReach)
Name Name of branch
(Inherited from Res1DReach)
ReachListIndex Data desription and time step data for a reach (also sometimes called a branch or a link)
(Inherited from Res1DReach)
ReverseDirection Reverse the positive flow direction of the reach. Default is false
(Inherited from Res1DReach)
StartNodeIndex Reference to the start node
(Inherited from Res1DReach)
TopoID TotoID of this reach
(Inherited from Res1DReach)

Methods

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)
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 Res1DReach)
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 Res1DReach)
GetDataItem Return data item of specified type if present, otherwise null
(Inherited from Res1DAbstractDataSet)
GetDigiPointCoords Returns an array of digi point coordinates.
(Inherited from Res1DReach)
Obsolete
GetGridPointCoords
(Inherited from Res1DReach)
Obsolete
GetHashCodeServes as the default hash function.
(Inherited from Object)
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 previous gridpoint is returned(lower chainage). At the first gridpoint the chainage of the gridpoint itself is returned.


(Inherited from Res1DReach)
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 prev gridpoint is returned (lower chainage). At the first gridpoint the chainage of the gridpoint itself is returned.


(Inherited from Res1DReach)
GetTypeGets the Type of the current instance.
(Inherited from Object)
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 next gridpoint returned (higher chainage). At the last gridpoint the chainage of the gridpoint itself is returned.


(Inherited from Res1DReach)
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 Res1DReach)
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 Res1DReach)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Res1DReach)

Fields

_dataItems List of data items
(Inherited from Res1DAbstractDataSet)
_id Identification string
(Inherited from Res1DAbstractDataSet)

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