RoutingModule also implements the IGraph interface, defining only the part of the routing network in the graph.
public class RoutingModule : IModule,
IModelStateReadWrite, IModuleNetwork, IModuleNetwork<IRoutingHDNode, IRoutingHDReach>,
IGraph, IProxyProvider, ISourcePointProxyProvider| Id | Id of module |
| Nodes | |
| Order | Order of module. Modules are processed in order. |
| Reaches | |
| Vertices | Vertices/nodes in the graph |
| 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) |
| FinalizeTimestep | FinalizeTimeStep allows the modules to do operations required when a time step has successfully completed |
| Finish | Release any license and clean up |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetProxy | Get a proxy for generic/global data |
| GetProxy(EngineNode) | Get a proxy for the node |
| GetProxy(EngineReach) | Get a proxy for the reach, covering a number of gridpoints |
| GetProxy(INetworkNode) | |
| GetProxy(INetworkReach) | |
| GetProxy(EngineReach, Int32) | Get a proxy for the gridpoint in the reach |
| GetProxy(INetworkReach, Int32) | |
| GetProxyReachGeneric(EngineReach) | Get a proxy for the reach, generic data (not gridpoint associated) |
| GetProxyReachGeneric(INetworkReach) | |
| GetReach | Maps an EngineReach to the corresponding HD Reach |
| GetSourcePointProxy(EngineNode) |
Get a source point proxy for the node.
Usually this can only be called after the Prepare(Diagnostics) function has been called. |
| GetSourcePointProxy(EngineReach, Int32) |
Get a source point proxy for the gridpoint in the reach.
Usually this can only be called after the Prepare(Diagnostics) function has been called. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| PerformTimestep | Perform timestep and return true if solution is accepted. Can be called several times for different values of Dt. |
| PreferredTimeStep |
Returns the preferred time step for the current state. It is called between every time step
and can increase as well as decrease the time step.
Used when AdaptiveTimeSteppingActivated is true. Do return the maximum of the allowed time step; in case a buffer is required, this is handled by a time step controller. |
| Prepare | Prepare module for first time step. |
| PrepareForTimeStep | Prepare module for time step (set state(n+1) = state(n)). |
| ReadState | Read state and apply to module. Returns true if state was successfully read. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteState | Write current state of module |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxyReachGeneric | (Defined by EngineExtensions) |