MLAxisRel

Pipe Network motion icon

 Function - A selected Axis performs a move for a specified distance relative to the current position.

This function adds a relative distance to the current Generator Position.

Inputs

Input

Data Type

Range

Unit

Default

Description

ID

DINT

No range

N/A

No default

ID Name of the Axis block.

DeltaPosition

LREAL

No range

User units

No default

Sets the Axis Delta Position or the relative distance to be moved.

See Set the Axis Block Position Units.

Outputs

Output

Data Type

Range

Unit

Description

Default (.Q)

BOOL

FALSE, TRUE

N/A

Returns TRUE when the function successfully executes.

  • This occurs immediately after the function is called.
  • The function does not wait for the motion profile to be completed.
  • See Function - General Rules.

Remarks


  • Use MLAxisGenIsRdy to know when a move has completed.
    The output of MLAxisRel can occur before moves have finished.

DeltaPosition Axis

  • The DeltaPosition input is signed so:
    • The move can be in the positive or negative direction.
    • The Axis moves this distance in User units.
  • The travel speed, acceleration, deceleration, and User units of the move are values inherited from the selected Axis.
  • The default settings are entered when an Axis is created and initiated, and can be changed with other MLAxis commands.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

 MLAxisRel(PipeNetwork.Axis1, 2500 )  ;

See Also