Click or drag to resize

IRes1DStructureReach Interface

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

Namespace:  DHI.Mike1D.ResultDataAccess
Assembly:  DHI.Mike1D.ResultDataAccess (in DHI.Mike1D.ResultDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface IRes1DStructureReach : IRes1DReach, 
	IRes1DDataSet, INetworkReach

The IRes1DStructureReach type exposes the following members.

Properties
  NameDescription
Public propertyDataItems
List of data items used for accessing the data.
(Inherited from IRes1DDataSet.)
Public propertyDigiPoints
List of digi points
(Inherited from IRes1DReach.)
Public propertyDirectionType
Direction of positive flow in the reach.
(Inherited from IRes1DReach.)
Public propertyEndNodeIndex
Index of the reach end node in the node list
(Inherited from IRes1DReach.)
Public propertyGridPoints
List of grid points
(Inherited from IRes1DReach.)
Public propertyId
Identification string
(Inherited from IRes1DDataSet.)
Public propertyIsStructureReach
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.)
Public propertyLength
Return length of reach, chainage-length
(Inherited from IRes1DReach.)
Public propertyLocationSpan
Location span that covers this reach.
(Inherited from INetworkReach.)
Public propertyName
Name of branch
(Inherited from IRes1DReach.)
Public propertyStartNodeIndex
Index of the reach start node in the node list
(Inherited from IRes1DReach.)
Public propertyTopoID
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.)
Top
Methods
  NameDescription
Public methodGetChainages(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.)
Public methodGetChainages(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.)
Public methodGetDataItem
Return data item of specified type if present, otherwise null
(Inherited from IRes1DDataSet.)
Public methodGetLowerLimitChainages(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.)
Public methodGetLowerLimitChainages(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.)
Public methodGetUpperLimitChainages(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.)
Public methodGetUpperLimitChainages(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.)
Public methodGridPointIndexForChainage
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.)
Top
Extension Methods
  NameDescription
Public Extension MethodDiameter
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.)
Public Extension MethodEndChainage
Extension method return the end chainage of a reach
(Defined by Res1DExtensions.)
Public Extension MethodGetDataItem
Return data item of specified type if present, otherwise null
(Defined by Res1DExtensions.)
Public Extension MethodGridpointSearch
Extension method searching within the grid points of a reach, using a binary search routine.
(Defined by Res1DExtensions.)
Public Extension MethodLocationSpan
Extension method to create a LocationSpan from a reach.
(Defined by Res1DExtensions.)
Public Extension MethodStartChaiange
Extension method return the start chainage of a reach
(Defined by Res1DExtensions.)
Public Extension MethodStartChainage
Extension method return the start chainage of a reach
(Defined by Res1DExtensions.)
Top
See Also