MLAxisAdd

Pipe Network motion icon

 Function - A selected Axis performs a move for a specified distance relative to the endpoint of the previous move.

This function adds a relative distance to the current target 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 to add to the endpoint of the previous move.

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.

  • TRUE is after the motion profile is complete.
  • See Function - General Rules.

Remarks

  • 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

MLAxisAdd(PipeNetwork.Axis1, LREAL#750.0 ) ;

See Also