com.kuka.roboticsAPI.commandModel
Class AbstractControllerCommand

java.lang.Object
  com.kuka.roboticsAPI.commandModel.AbstractControllerCommand

All Implemented Interfaces:

IControllerCommand

Direct Known Subclasses:

Instruction, SPRCommand

public abstract class AbstractControllerCommand
extends Object
implements IControllerCommand

An abstract controller command is a reference implementation of the controller command interface. The getController-method is abstract so that an implementing command must provide that method.

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

AbstractControllerCommand()

Method Summary

void	acquireResources(ICommandContainer container) Asks the command to acquire it's resources that are needed for execution.
void	releaseResources(ICommandContainer container) Tells the command to release it's resources.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kuka.roboticsAPI.commandModel.IControllerCommand

getController, getRuntimeData

Constructor Detail

AbstractControllerCommand

public AbstractControllerCommand()

Method Detail

acquireResources

public void acquireResources(ICommandContainer container)
                      throws InterruptedException

Asks the command to acquire it's resources that are needed for execution.

This method can block until the resources are available. The method is called before the command is passed to the controller. Implementing classes should throw an exception if preparation fails.

Specified by:

acquireResources in interface IControllerCommand

Parameters:

container - The container which will be used for the execution of the command.

Throws:

InterruptedException - The method may throw an InterruptedException if waiting was interrupted.

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.

releaseResources

public void releaseResources(ICommandContainer container)

Tells the command to release it's resources.

Specified by:

releaseResources in interface IControllerCommand

Parameters:

container - The container which was used for the execution of the command.

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.