com.ur.urcap.api.domain.userinteraction.robot.movement

Class RobotMovementCallback

java.lang.Object

com.ur.urcap.api.domain.userinteraction.robot.movement.RobotMovementCallback

public abstract class RobotMovementCallback
extends Object

The robot movement callback.

Extend this abstract class to execute custom code when the end user accepts/cancels the request to move the robot or when errors occur.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
RobotMovementCallback()

Method Summary

Modifier and Type	Method and Description
void	onCancel(MovementCancelEvent event) This method is called if the end user cancels the move request (before reaching the target position).
abstract void	onComplete(MovementCompleteEvent event) This method is called when the robot has been moved to the desired target position by the end user.
void	onError(MovementErrorEvent event) This method is called when an error occurs in the move request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RobotMovementCallback

public RobotMovementCallback()

Method Detail

onComplete

public abstract void onComplete(MovementCompleteEvent event)

This method is called when the robot has been moved to the desired target position by the end user.

This method must be overridden.

Parameters:

event - This object holds information related to the onComplete event.

onCancel

public void onCancel(MovementCancelEvent event)

This method is called if the end user cancels the move request (before reaching the target position).

Overriding this method is optional.

Parameters:

event - This object holds information related to the onCancel event.

onError

public void onError(MovementErrorEvent event)

This method is called when an error occurs in the move request.

Overriding this method is optional.

Parameters:

event - This object holds information related to the onError event.