Sets all model parameter values using values in a SimulationInputs struct

Namespace: WaterSimDCDC
Assembly: WaterSimDCDC_API (in WaterSimDCDC_API.dll) Version: 5.0.0.10 (5.0.0.10)

Syntax

C#
public bool SetSimulationInputs(
	SimulationInputs si
)
Visual Basic
Public Function SetSimulationInputs ( _
	si As SimulationInputs _
) As Boolean

Parameters

si
Type: WaterSimDCDC..::..SimulationInputs
values to set in model

Return Value

true if no errors, including range errors, otherwise ModelParamters will throw an exception

Remarks

Some caution should be used with this method, a true return value only means thet values were in range, not that the ModelParameters were actually set. Write access to baseinputs is blocked once a Simulation starts. Attempting to set them at this Simulation state will not succeed, but will return a true value and evoke no exception.

Exceptions

ExceptionCondition
WaterSimDCDC..::..WaterSim_Exceptionif values in si do not pass range checks

See Also