Rice Lake iRite IDE - Manual (Page 59)

920i Programming Reference - API Reference 55
Example:
SP3DUR : DateTime;
…
GetSPTime (3, SP3DUR);
WriteLn (Port1, "Current Trip Duration of SP3 is", SP3DUR);
GetSPHyster
Sets V to the current hysteresis value (HYSTER parameter) of the setpoint SP.
Method Signature:
function GetSPHyster (SP : Integer; V : Real) : SysCode;
Parameters:
[in] S P Setpoint number
[out] V Hysteresis value
SysCode values returned:
SysInvalidSetpoint The setpoint specified by SP does not exist.
SysInvalidRequest The setpoint specified by SP has no hysteresis HYSTER) parameter.
SysOK The function completed successfully.
Example:
SP5Hyster : Real;
…
GetSPHyster (5, SP5Hyster);
WriteLn (Port1, "Current Hysteresis Value of SP5 is", SP5Hyster);
GetSPNSample
For averaging (AVG) setpoints, sets N to the current number of samples (NSAMPLE parameter) of the setpoint
SP
.
Method Signature:
function GetSPNSample (SP : Integer; VAR N : Integer) : SysCode;
Parameters:
[in] S P Setpoint number
[out] N Sample value
SysCode values returned:
SysInvalidSetpoint The setpoint specified by SP does not exist.
SysInvalidRequest The setpoint specified by SP has no NSAMPLE parameter.
SysOK The function completed successfully.
Example:
SP5NS : Integer;
…
GetSPNSample (5, SP5NS);
WriteLn (Port1, "Current NSample Value of SP5 is", SP5NS);
GetSPPreact
Sets V to the current preact value (PREACT parameter) of the setpoint SP.
Method Signature:
function GetSPPreact (SP : Integer; V : Real) : SysCode;
Parameters:
[in] S P Setpoint number
[out] V Preact value
SysCode values returned:
SysInvalidSetpoint The setpoint specified by SP does not exist.
SysInvalidRequest The setpoint specified by SP has no preact (PREACT) parameter.
SysOK The function completed successfully.