RampValue Subroutine

Manually ramps the specified database block by increasing or decreasing its current value by a specified percentage of the engineering units (EGU) range.

Syntax

RampValueRampValue, ByPercent, [DataPoint], [intErrorMode]

Properties

The RampValue subroutine syntax has these parts:

Part

Description

RampValue

String. The value you want to use to ramp the database block.

ByPercent

Boolean. If True, the block is ramped by the percentage of the EGU range. If False, the data point is ramped by the RampValue.

DataPoint

String. (Optional). The name of the database block that you want to ramp. If no block is specified, the value of the data source associated with the selected object is ramped.

intErrorMode

Integer. (Optional). The error mode.
0 (default) – Allows the subroutines to provide the error messages. Errors are displayed in the form of a message box. If no entry is made for the intErrorMode parameter, the default is used.

1 – Allows the user to handle the error messages. Errors in the subroutines are passed back to the calling routine for handling.

2 – Writes errors to all destinations. No error messages display. Instead, the errors are written to all iFIX destinations, including the Alarm History window destinations using SendOperatorMessage.

 

Example