Analog Control Blocks > Enhanced Ramp function block

Enhanced Ramp function block parameters

The following table lists the system parameters for the Enhanced Ramp function block:

Table: Enhanced Ramp function block system parameters
Parameter Units Description
COMPLETE None Indicates that ramp calculation is finished and the final value was written to the target block parameter to be ramped (except for some Variable endpoint and Ramp up or Ramp down configurations).
ERAMP_ENABLE None Discrete input value and status that starts the ramp state machine and may activate ramp calculation.
ERAMP_END_VALUE EU of IN The ramp end point input value and status, where (LO_LIM ≤ ERAMP_END_VALUE ≤ HI_LIM).

You can configure the ERAMP_END_VALUE parameter as a positive or negative value; the logic of the Enhanced Ramp function block determines if a ramp is positive or negative based on its direction, start value, and end value.

HI_LIM EU of IN The high limit of the ramp value.

You can configure the HI_LIM parameter as a positive or negative value; the logic of the Enhanced Ramp function block determines if a ramp is positive or negative based on its direction, start value, and end value.

IN Determined by source The analog input value and status that can be used as the ramp starting point.

You can configure the IN parameter as a positive or negative value; the logic of the Enhanced Ramp function block determines if a ramp is positive or negative based on its direction, start value, and end value.

LO_LIM EU of IN The low limit of the ramp value.

You can configure the LO_LIM parameter as a positive or negative value; the logic of the Enhanced Ramp function block determines if a ramp is positive or negative based on its direction, start value, and end value.

OUT EU of IN The analog output value and status.
PAUSE None The discrete input value and status that stops ramp calculation. The last previous OUT and TIME_REMAIN parameter values persist.
ERAMP_ACTIVE None An indicator of an active ramp.
ERAMP_DIR None A named set that specifies the configured direction of a ramp: Ramp up, Ramp down, or Ramp in both directions.
ERAMP_IN_MODE None A named set parameter used to specify the target block’s mode for ramping as: AUTO, LO, MAN, RCAS, or ROUT.

The default mode value is AUTO.

ERAMP_OPTS None The following ramp configuration options are available:
Option Default
Autotracking Enabled
Obey the limits Disabled
Pause if mode changes Disabled
Reset if IN value changes Disabled
Use REF_RAMP_VAL as IN Enabled
Variable endpoint Disabled
Note

If the Variable endpoint option of the ERAMP_OPTS parameter is enabled, settings for the Autotracking, Reset if IN value changes, and Use REF_RAMP_VAL as IN options are overridden, and set to their default.

ERAMP_RATE EU of IN per TIME_UNIT The rate at which ramp calculation increases or decreases.

You must configure the ERAMP_RATE parameter as a positive value; the logic of the Enhanced Ramp function block determines if a ramp is positive or negative based on its direction, start value, and end value.

ERAMP_STATE None The state of the Enhanced Ramp function block: Complete, Enabled, Paused, Ramping, or Stopped.
ERAMP_TIME Unit of TIME_UNIT The time period for the output to ramp from its initial value to ERAMP_END_VALUE.
ERAMP_TYPE None A named set that specifies ramp calculation: Use Rate parameter or Use Time parameter.
REF_MODE None An external reference to the mode of the target function block with which the Enhanced Ramp function block is associated.
REF_RAMP_AUTO EU of IN An external reference to the target block parameter that is to be ramped when the ERAMP_IN_MODE parameter is set to AUTO. The REF_RAMP_AUTO parameter has no default; it must be configured explicitly.

To prevent a warning message from being generated during download, specify #IGNORE.

REF_RAMP_LO EU of IN An external reference to the target block parameter that is to be ramped when the ERAMP_IN_MODE parameter is set to LO. The REF_RAMP_LO parameter has no default; it must be configured explicitly.

To prevent a warning message from being generated during download, specify #IGNORE.

REF_RAMP_MAN EU of IN An external reference to the target block parameter that is to be ramped when the ERAMP_IN_MODE parameter is set to MAN. The REF_RAMP_MAN parameter has no default; it must be configured explicitly.

To prevent a warning message from being generated during download, specify #IGNORE.

REF_RAMP_PATH None The current path to the target block parameter that is to be ramped. The REF_RAMP_PATH parameter is a read-only string.
REF_RAMP_RCAS EU of IN An external reference to the target block parameter that is to be ramped when the ERAMP_IN_MODE parameter is set to RCAS. The REF_RAMP_RCAS parameter has no default; it must be configured explicitly.

To prevent a warning message from being generated during download, specify #IGNORE.

REF_RAMP_ROUT EU of IN An external reference to the target block parameter that is to be ramped when the ERAMP_IN_MODE parameter is set to ROUT. The REF_RAMP_ROUT parameter has no default; it must be configured explicitly.

To prevent a warning message from being generated during download, specify #IGNORE.

REF_RAMP_VAL EU of IN The current external reference to the target block parameter that is to be ramped. The REF_RAMP_VAL parameter contains a read-only value.
RESUME None If a ramp is paused by Enhanced Ramp function block logic, the ramp does not resume until the operator sets the RESUME parameter to True. The default value is False.
TIME_REMAIN Unit of TIME_UNIT The time remaining until ramp calculation concludes.
TIME_UNIT Seconds, Minutes, Hours, or Days A named set that specifies the unit of time to be used: Seconds, Minutes, Hours, or Days.
TRK_IN_D None Initiates the output tracking function, where 1 is active and 0 is inactive.
VAR_THRESHOLD EU of IN For a Variable endpoint configuration, the threshold used to determine if the IN and ERAMP_END_VALUE parameter values are equal.
Tip

Default values and information about data types for Enhanced Ramp function block parameters is available by expanding the Parameter View window in Control Studio.