com.kuka.roboticsAPI.controllerModel.recovery
Interface IRecovery

All Known Implementing Classes:

RecoveryManager

public interface IRecovery

Used to determine if actions are necessary to resume the application. Actions which have to be executed to resume the application are called 'Recovery'.

Method Summary

IRecoveryStrategy	getRecoveryStrategy(Robot robot) Returns the recovery strategy which is executed if the application is resumed.
boolean	isRecoveryRequired() Determines if actions are necessary to resume the application.
boolean	isRecoveryRequired(Robot robot) Determines if actions are necessary to resume the application.

Method Detail

isRecoveryRequired

boolean isRecoveryRequired()

Determines if actions are necessary to resume the application. This function considers all robots.

Returns:

true if at least one of the robots needs to perform actions to resume the application given that the application is in state pause. Otherwise the function returns false.

isRecoveryRequired

boolean isRecoveryRequired(Robot robot)

Determines if actions are necessary to resume the application. This function only considers the given robot.

Parameters:

robot - device under investigation.

Returns:

true if the robot needs to perform actions to resume the application given that the application is in state pause. Otherwise the function returns false.

getRecoveryStrategy

IRecoveryStrategy getRecoveryStrategy(Robot robot)

Returns the recovery strategy which is executed if the application is resumed.

Parameters:

robot - device under investigation.

Returns:

the recovery strategy which is executed if the application is resumed. If no recovery strategy is available or required, the function returns null.