MLGearWriteOff

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 Offset value of a selected Gear Pipe Block.

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


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

Arguments

Input

BlockID

Description

ID number of an initialized Gear Pipe Block

 

Data type

DINT

 

Range

[-2147483648, 2147483648]

 

Unit

N/A

 

Default

—

Offset

Description

New Offset value to be assigned to selected Gear Pipe Block. Values lower then 1.0 can be entered, but require a leading zero (for example 0.8 instead of .8)

 

Data type

LREAL

 

Range

—

 

Unit

User unit

 

Default

—

Output

Default (.Q)

Description

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

See Function - General Rules for more information.
 

Data type

BOOL

 

Unit

N/A

Return Type

BOOL

Related Functions

MLGearReadOffset

MLGearInit

Example

Structured Text

 

//Set the Offset value of Gear1 Pipe Block to 5 User Units

MLGearWriteOff(PipeNetwork.GEAR1, 5.0);

 

Ladder Diagram

MLGearWriteOff: LD example

 

Function Block Diagram

MLGearWriteOff: FBD example

Go back to the top of the page[Top]