getParameter

getParameter is used to obtain the value for a defined parameter. It is most useful for input parameters, but it can also be used to obtain the current value of an output parameter.

Syntax

Arguments

parameterName
String; name of the parameter for which to get the value of. The parameter must be defined for this unit operation.

Returns

value
Value of the parameter. The data type of the value corresponds to the type of the parameter. Boolean parameters return a scalar value of 0 or 1 (1 is True, 0 is False)

Examples

» getParameter('split factor')

ans =

    0.5000

» getParameter('maximum iterations')

ans =

   100

» getParameter('full report')

ans =

     1

» getParameter('type')

ans =

Adiabatic

getParameter('no such parameter')
Evaluation error: Invalid parameter name: no such parameter