com.kuka.roboticsAPI.controllerModel.sunrise
Class SunriseRecordingCommand

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.SunriseRecordingCommand

All Implemented Interfaces:

IControllerCommand

public class SunriseRecordingCommand
extends Object
implements IControllerCommand

Class to manage recordingSPRs and DataRecorder.

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

SunriseRecordingCommand(boolean hasTrigger)
Creates a new SunriseRecordingCommand.

Method Summary

void	acquireResources(ICommandContainer container) Asks the command to acquire it's resources that are needed for execution.
Controller	getController() Gets the controller to which the command is targeted.
DataRecorder	getDataRecorder() Gets the data recorder configuration.
RecorderConfiguration	getRecorderConfiguration() Gets the recorder configuration.
SPR	getRecordingSPR() Gets the recording SPR.
ICommandRuntimeData	getRuntimeData() Gets the runtime data object associated with the command.
boolean	hasTrigger() Gets the information about whether data recorder is used as trigger or not.
void	releaseResources(ICommandContainer container) Tells the command to release it's resources.
void	setDataRecorder(DataRecorder recorder) Sets the data recorder.
void	setRecorderConfiguration(RecorderConfiguration recorderConfiguration) Sets the recorder configuration.
void	setRecordingSPR(SPR recordingSpr) Sets the recording SPR.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SunriseRecordingCommand

public SunriseRecordingCommand(boolean hasTrigger)

Creates a new SunriseRecordingCommand.

Parameters:

hasTrigger - the information about whether data recorder is used as trigger or not.

Method Detail

setRecordingSPR

public void setRecordingSPR(SPR recordingSpr)

Sets the recording SPR.

Parameters:

recordingSpr - the recording SPR.

getRecordingSPR

public SPR getRecordingSPR()

Gets the recording SPR.

Returns:

The recording SPR.

setRecorderConfiguration

public void setRecorderConfiguration(RecorderConfiguration recorderConfiguration)

Sets the recorder configuration.

Parameters:

recorderConfiguration - the recorder configuration.

getRecorderConfiguration

public RecorderConfiguration getRecorderConfiguration()

Gets the recorder configuration.

Returns:

The recorder configuration.

getDataRecorder

public DataRecorder getDataRecorder()

Gets the data recorder configuration.

Returns:

The data recorder.

setDataRecorder

public void setDataRecorder(DataRecorder recorder)

Sets the data recorder.

Parameters:

recorder - the data recorder.

getController

public Controller getController()

Description copied from interface: IControllerCommand

Gets the controller to which the command is targeted.

Specified by:

getController in interface IControllerCommand

Returns:

The controller to which the command is targeted. null is not allowed!

acquireResources

public void acquireResources(ICommandContainer container)

Description copied from interface: IControllerCommand

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.

releaseResources

public void releaseResources(ICommandContainer container)

Description copied from interface: IControllerCommand

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.

getRuntimeData

public ICommandRuntimeData getRuntimeData()

Description copied from interface: IControllerCommand

Gets the runtime data object associated with the command.

Specified by:

getRuntimeData in interface IControllerCommand

Returns:

the runtime data associated with the command. Can be null.

hasTrigger

public boolean hasTrigger()

Gets the information about whether data recorder is used as trigger or not.

Returns:

true if it is used as trigger, false otherwise.

toString

public String toString()

Overrides:

toString in class Object