MLGearWriteOff

Pipe Network motion icon

 Function - Sets the Offset 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.

Offset

LREAL

No range

User units

No default

New Offset 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

FALSE, TRUE

N/A

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

  • The output of a Gear Block = Input value * Ratio + Offset.
  • See Function - General Rules.

Remarks

None

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

//Set the Offset value of Gear1 Pipe Block to 5 User Units
MLGearWriteOff(PipeNetwork.GEAR1, 5.0);

See Also