IF_Jogging - Stop (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Stopping the carrier movement controlled by the move command Jogging.

Description

The method IF_Jogging - Stop stops a carrier movement started by the method IF_Jogging - Start.

When the method IF_Jogging - Stop is called, the carrier is stopped with a positioning command setting the velocity to zero:

Vel = 0

The motion parameters specified by the method SetMotionParameterJogging (MaxAcceleration, MaxDeceleration, and MaxAbsJerk) are used for stopping the movement. For more details on the motion parameters, refer to SetMotionParameterJogging.

With the method IF_Jogging - Stop, the movement of the carrier is stopped without considering other carriers, for example without considering if the carrier in front stops faster. Take this into account when using this method.

Inputs

The method has no inputs.

Outputs

Output	Data type	Description
q_xError	BOOL	Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING [255]	Provides additional diagnostic and status information as a text message.