NetworkDataStateReaderReadNetworkState Method |
Read a network state, based on the indices of nodes and reaches specified,
storing values in a
NetworkDataT object.
A network states contains one array of node values, matching the nodesinput,
and a number of arrays of reach values, matching the reaches input. For
reaches, the array must contain values on all H grid points or all Q grid points.
Namespace:
DHI.Mike1D.Engine
Assembly:
DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax public static NetworkData<double> ReadNetworkState(
this ModelStateReader reader,
int[] nodes,
int[] reaches
)
<ExtensionAttribute>
Public Shared Function ReadNetworkState (
reader As ModelStateReader,
nodes As Integer(),
reaches As Integer()
) As NetworkData(Of Double)
public:
[ExtensionAttribute]
static NetworkData<double>^ ReadNetworkState(
ModelStateReader^ reader,
array<int>^ nodes,
array<int>^ reaches
)
Parameters
- reader
- Type: DHI.Mike1D.ModelStateModelStateReader
[Missing <param name="reader"/> documentation for "M:DHI.Mike1D.Engine.NetworkDataStateReader.ReadNetworkState(DHI.Mike1D.ModelState.ModelStateReader,System.Int32[],System.Int32[])"]
- nodes
- Type: SystemInt32
[Missing <param name="nodes"/> documentation for "M:DHI.Mike1D.Engine.NetworkDataStateReader.ReadNetworkState(DHI.Mike1D.ModelState.ModelStateReader,System.Int32[],System.Int32[])"]
- reaches
- Type: SystemInt32
[Missing <param name="reaches"/> documentation for "M:DHI.Mike1D.Engine.NetworkDataStateReader.ReadNetworkState(DHI.Mike1D.ModelState.ModelStateReader,System.Int32[],System.Int32[])"]
Return Value
Type:
NetworkDataDoubleNetworkDataT object containing state values.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
ModelStateReader. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also