ModelStateReader Methods |
The ModelStateReader type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AppendLineInfo |
Append line information to string. If no line information is available, the input string is returned directly.
|
| Close |
Close reader and underlying stream.
|
| 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.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Open(Stream) |
Open reader and read from stream
|
| Open(String) |
Open reader and read from file
|
| Read |
Read next token from state stream
|
| Read(StateToken) |
Reads next element from the state stream and validates that the tokenType matches.
It throws an exception if the tokenType does not match |
| ReadBoolean |
Read boolean
|
| ReadBooleans |
Read a list of integers
|
| ReadDateTime |
Read a DateTime
|
| ReadDateTimes |
Read a list of DateTimes
|
| ReadDouble |
Read double
|
| ReadDoubles |
Read a list of doubles
|
| ReadEndObject |
Reads next element from the state stream and validates that it is and end object element.
|
| ReadInt |
Read integer
|
| ReadInts |
Read a list of integers
|
| ReadStartObject |
Reads the next element from the state stream and validates that the
tokenName matches.
If file version and bridge version matches, if object is not found, an exception is thrown. If file version is older than bridge version, and object is not found, false is returned. |
| ReadString |
Read string
|
| ReadStrings |
Read a list of strings
|
| ReadTimeSpan |
Read a TimeSpan
|
| Skip |
Skip current element, moves beyond the ObjectEnd
of the current section.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryRead |
First time called, this will read the next token.
At subsequent calls, a new token will only be read
if the previous call returned true
|
| TryReadStartObject |
Reads the next element, but does only move by it if the
tokenName matches.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ReadBoolean(String) | Overloaded.
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadBoolean(String, ActionBoolean) | Overloaded.
Read a parameter from state, and if there, apply it.
(Defined by ModelStateExtensions.) |
| ReadBooleans |
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadDateTime(String) | Overloaded.
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadDateTime(String, ActionDateTime) | Overloaded.
Read a parameter from state, and if there, apply it.
(Defined by ModelStateExtensions.) |
| ReadDateTimes |
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadDouble(String) | Overloaded.
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadDouble(String, ActionDouble) | Overloaded.
Read a parameter from state, and if there, apply it.
(Defined by ModelStateExtensions.) |
| ReadDoubles |
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadInt(String) | Overloaded.
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| ReadInt(String, ActionInt32) | Overloaded.
Read a parameter from state, and if there, apply it.
(Defined by ModelStateExtensions.) |
| ReadNetworkState |
Read a network state, based on the indices of nodes and reaches specified,
storing values in a NetworkDataT object.
(Defined by NetworkDataStateReader.)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. |
| ReadString |
Read a parameter from state, return its value
(Defined by ModelStateExtensions.) |
| TryReadDouble |
Read a parameter from state, and if there, apply it.
(Defined by ModelStateExtensions.) |
| Warning |
Warning while reading state
(Defined by ModelStateExtensions.) |
See Also