Click or drag to resize

DataModule Methods

The DataModule type exposes the following members.

Methods
  NameDescription
Public methodAddDataItem(IEngineDataItemDouble)
Add a dataset to the datamodule
Public methodAddDataItem(IEngineDataItemInt32)
Add a dataset to the datamodule
Public methodAddDataItem(IEngineDataItemTimeSpan)
Add a dataset to the datamodule
Public methodAddDataItem(IEngineDataItemMinMaxValueContainer)
Add a dataset to the datamodule
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFinalizeTimestep
FinalizeTimeStep allows the modules to do operations required when a time step has successfully completed
Public methodFinish
Release any license and clean up
Public methodGetDataItem
Get a dataset from the datamodule
Public methodGetDataItemInt
Get a dataset from the datamodule
Public methodGetDataItemMinMax
Get a dataset from the datamodule
Public methodGetDataItemTimeSpan
Get a dataset from the datamodule
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProxy
Get a proxy for generic/global data
Public methodGetProxy(EngineNode)
Get a proxy for the node
Public methodGetProxy(EngineReach)
Get a proxy for the reach, covering a number of gridpoints
Public methodGetProxy(EngineReach, Int32)
Get a proxy for the gridpoint in the reach
Public methodGetProxyReachGeneric
Get a proxy for the reach, generic data (not gridpoint associated)
Public methodGetSourcePoint(EngineReach, Int32)
Get a source point for the gridpoint in the reach. Usually this can only be called after the Prepare(Diagnostics) function has been called.
Public methodGetSourcePoint(EngineReach, Type)
Get a source point covering all gridpoints in the reach of the specified type Usually this can only be called after the Prepare(Diagnostics) function has been called.
Public methodGetSourcePoint(EngineReach, Type, ILocationSpan)
Get a source point covering all gridpoints in the span of the specified type Usually this can only be called after the Prepare(Diagnostics) function has been called.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInititalize
Initialize module
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPerformTimestep
Perform timestep and return true if solution is accepted. Can be called several times for different values of Dt.
Public methodPreferredTimeStep
Increase time step after PerformTimestep() returned true. If possible, the time step is increased before next PerformTimestep().
Public methodPrepare
Prepare module for first time step.
Public methodPrepareForTimeStep
Prepare module for next time step (set state(n+1) = state(n)).
Public methodRemoveDataItem(IEngineDataItemDouble)
Remove a dataset from the datamodule
Public methodRemoveDataItem(IEngineDataItemInt32)
Remove a dataset from the datamodule
Public methodRemoveDataItem(IEngineDataItemTimeSpan)
Remove a dataset from the datamodule
Public methodRemoveDataItem(IEngineDataItemMinMaxValueContainer)
Remove a dataset from the datamodule
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteState
Top
Extension Methods
See Also