MLGearWriteRatio

Pipe Network motion icon

 FunctionClosed A function calculates a result according to the current value of its inputs. A function has no internal data and is not linked to declared instances. - Sets the Ratio value of a selected Gear Pipe Block.

Inputs

Input

Data Type

Range

Unit

Default

Description

BlockID

DINT

-2147483648 to 2147483647

N/A

No default

ID number of an initialized Gear Pipe Block.

Ratio

LREAL

No range

User unit/sec

No default

New Ratio value to be assigned to the selected Gear Pipe Block.

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

Outputs

Output

Data Type

Range

Unit

Description

Default (.Q)

BOOL

No range

N/A

Returns TRUE if the Ratio value is changed in the selected Gear Pipe Block.

See Pipe Network - General Rules.

Remarks

The output of a Gear Block = Input value * Ratio + Offset.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

//Set the Ratio value of Gear1 Pipe Block to 5
MLGearWriteRatio(PipeNetwork.GEAR1, 5.0);

See Also