Rice Lake iRite IDE User Manual

Page 58

Advertising
background image

54

920i

Programming Reference

GetSPBand

Sets V to the current band value (BANDVAL parameter) of the setpoint SP.

Method Signature:
function GetSPBand (SP : Integer; V : Real) : SysCode;

Parameters:

[in]

S

P

Setpoint number

[out]

V

Band value

SysCode values returned:

SysInvalidSetpoint

The setpoint specified by

SP

does not exist.

SysInvalidRequest

The setpoint specified by

SP

has no hysteresis (BANDVAL) parameter.

SysOK

The function completed successfully.

Example:
SP7Bandval : Real;

GetSPBand (7, SP7BAndval);

WriteLn (Port1, "Current Band Value of SP7 is", SP7Bandval);

GetSPCaptured

Sets V to the weight value that satisfied the setpoint SP.

Method Signature:
function GetSPCaptured (SP : Integer; V : Real) : SysCode;

Parameters:

[in]

S

P

Setpoint number

[out]

V

Captured weight value

SysCode values returned:

SysInvalidSetpoint

The setpoint number specified by

SP

is less than 1 or greater than 100.

SysInvalidRequest

The setpoint has no captured value.

SysOK

The function completed successfully.

GetSPCount

For DINCNT setpoints, sets Count to the value specified for setpoint SP.

Method Signature:
function GetSPCount (SP : Integer; VAR Count : Integer) : SysCode;

Parameters:

[in]

S

P

Setpoint number

[out]

Count

Count value

SysCode values returned:

SysInvalidSetpoint

The setpoint number specified by

SP

is less than 1 or greater than 100.

SysInvalidRequest

The specified setpoint is not a DINCNT setpoint.

SysOK

The function completed successfully.

GetSPDuration

For time of day (TOD) setpoints, sets DT to the current trip duration (DURATION parameter) of the setpoint SP.

Method Signature:
function GetSPDuration (SP : Integer; VAR DT : DateTime) : SysCode;

Parameters:

[in]

S

P

Setpoint number

[out]

DT

Setpoint trip duration

SysCode values returned:

SysInvalidSetpoint

The setpoint specified by

SP

does not exist.

SysInvalidRequest

The setpoint specified by

SP

has no DURATION parameter.

SysOK

The function completed successfully.

Advertising
This manual is related to the following products: