com.kuka.roboticsAPI.controllerModel.recovery
Class RecoveryManager

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.recovery.RecoveryManager

All Implemented Interfaces:

IRecovery

public class RecoveryManager
extends Object
implements IRecovery

Features which provides and stores all information needed to resume an application, given that it is possible to resume the application.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

RecoveryManager(Collection<? extends Device> devices, IExecutionServicePaused sesPausedInterface)
Creates a new instance of the feature.

Method Summary

IExecutableRecoveryStrategy	getExecRecoveryStrategy(Robot robot) Returns the executable recovery strategy which is executed if the application is resumed.
IRecoveryStrategy	getRecoveryStrategy(Robot robot) Returns the recovery strategy which is executed if the application is resumed.
Collection<Robot>	getRobots() Returns all Robot's of the recovery feature.
boolean	isRecoveryRequired() Determines if actions are necessary to resume the application.
boolean	isRecoveryRequired(Robot robot) Determines if actions are necessary to resume the application.
void	setRecoveryInfo(Robot robot, RecoveryInformation recoveryinfo) Saves the device state which has to be recovered if the application is resumed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryManager

public RecoveryManager(Collection<? extends Device> devices,
                       IExecutionServicePaused sesPausedInterface)

Creates a new instance of the feature.

Parameters:

devices - the devices of the controller.

sesPausedInterface - interface which allows to request if the sunrise execution service is paused.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Method Detail

isRecoveryRequired

public boolean isRecoveryRequired()

Description copied from interface: IRecovery

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

Specified by:

isRecoveryRequired in interface IRecovery

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

public boolean isRecoveryRequired(Robot robot)

Description copied from interface: IRecovery

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

Specified by:

isRecoveryRequired in interface IRecovery

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

public IRecoveryStrategy getRecoveryStrategy(Robot robot)

Description copied from interface: IRecovery

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

Specified by:

getRecoveryStrategy in interface IRecovery

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.

getExecRecoveryStrategy

public IExecutableRecoveryStrategy getExecRecoveryStrategy(Robot robot)

Returns the executable 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.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

setRecoveryInfo

public void setRecoveryInfo(Robot robot,
                            RecoveryInformation recoveryinfo)

Saves the device state which has to be recovered if the application is resumed.

Parameters:

robot - The robot for which the recovery info applies

recoveryinfo - The information that describes the state of the device that should be restored by the recovery strategies.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getRobots

public Collection<Robot> getRobots()

Returns all Robot's of the recovery feature.

Returns:

all Robot's of the recovery feature.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.