Gear

Name

Description

MLGearInit

Initializes a Gear Pipe Block with user-defined settings and for use in a PLC program.

MLGearReadOffset

Returns the Offset value of a selected Gear Block from the Pipe Network.

MLGearReadOffSlp

Returns the Offset Slope value of a selected Gear Block from the Pipe Network.

MLGearReadRatio

Returns the Ratio value of a selected Gear Block from the Pipe Network.

MLGearReadRatSlp

Returns the Ratio Slope value of a selected Gear Block from the Pipe Network.

MLGearWriteOff

Sets the Offset value of a selected Gear Pipe Block.

MLGearWriteOSlp

Sets the Offset Slope value of a selected Gear Pipe Block.

MLGearWriteRatio

Sets the Ratio value of a selected Gear Pipe Block.

MLGearWriteRatSlp

Sets the Ratio Slope value of a selected Gear Pipe Block.

Purpose

The purpose of the Gear block is to amplify / attenuate (with a ratio) and shift (with an offset) the flow of values.

  • A Gear may have a ratio and offset less or greater than one, or even zero.
  • Ratio and offset may be changed dynamically during application execution.
  • A slope may be specified to limit the rate at which step changes in ratio and offset are implemented.

Parameters

Parameter

Description

Modulo

Modulo mode adapts the output values according to the ModuloPosition (modulo).

  • TRUE when the mode is modulo.
  • Modulo mode adapts the output values according to the ModuloPosition (modulo).

Offset

Input offset of a new Gear Pipe Block.

  • Values lower than 1.0 can be entered, but require a leading 0 (zero).
    • Example: 0.8 instead of .8.

OffsetSlope

User-defined limit at which step changes in Offset are implemented.

  • This sets the maximum rate of change at the pipe block output resulting from changes in Offset parameters.
    • When set to the MAX (the default setting), the slope is infinite.
  • Units are user units per second for OffsetSlope.
  • Values lower than 1.0 can be entered, but require a leading 0 (zero).
    • Example: 0.8 instead of .8.

Ratio

Ratio coefficient of a new Gear Pipe Block.

  • Values lower than 1.0 can be entered, but require a leading 0 (zero).
    • Example: 0.8 instead of .8.

RatioSlope

User-defined limit at which step changes in Ratio are implemented.

  • This sets the maximum rate of change at the pipe block output resulting from changes in Ratio parameters.
    • When set to the MAX (the default setting), the slope is infinite.
  • Units are 1/second for RatioSlope.
  • Values lower than 1.0 can be entered, but require a leading 0 (zero).
    • Example: 0.8 instead of .8.
 
Output = Ratio * Input + Offset

Examples: Gear Functions

The output value starts with offset = 0 and gain = 1 (blue line). (Figure 1)

Figure 1: Offset = 0 and Gain = 1

Call the MLGearWriteOff function to modify the Offset.

This is where Offset_Slope is set with the MLGearWriteOSlp function. (Figure 2)

Figure 2: Offset_Slope set with MLGearWriteOSlp

After setting the Offset (Q=TRUE in the previous figure), call the MLGearWriteRatio function to modify the gear Ratio.

This is where Gain_Slope is set with the MLGearWriteRatSlp function. (Figure 3)

Figure 3: Gain_Slope set with MLGearWriteRatSlp

The output value is adapted with the gear offset and ratio (blue line). (Figure 4)

Figure 4: Output value adapted with gear offset and ratio

Associated Data

  • OutputValue: Output value of the data flows.
  • IsReady: Boolean set to TRUE when the pipe block is ready.
  • INPOS: reserved for debugging purposes.