com.kuka.roboticsAPI.controllerModel
Class RecordingService

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.ControllerService
      com.kuka.roboticsAPI.controllerModel.RecordingService

Direct Known Subclasses:

SunriseRecordingService

public abstract class RecordingService
extends ControllerService

Base abstract service class for data recording and statistic calculation.

Constructor Summary

RecordingService()

Method Summary

abstract void	enableRecording(DataRecorder dataRecorder, boolean hasTrigger) Enables the data recorder.
abstract String	getDefaultFileName(DataRecorder dataRecorder) Provides the name of the file in which the data will be saved.
abstract SPR	getRecordingSPR(DataRecorder dataRecorder) Provides the recording SPR in which the dataRecorder is running.
abstract boolean	isEnabled() Provides the information about whether the recording is enabled or not.
abstract boolean	isEvaluating(TorqueEvaluator torqueEvaluator) Provides the information about whether the statistic data are being evaluated now or not.
abstract boolean	isRecording() Provides the state of the recording process.
abstract void	startEvaluation(TorqueEvaluator torqueEvaluator) Starts the torque statistic data evaluation.
abstract void	startRecording(DataRecorder dataRecorder) Starts recording of data.
abstract TorqueStatistic	stopEvaluation(TorqueEvaluator torqueEvaluator) Stops data evaluation and returns the desired statistic result.
abstract void	stopRecording(DataRecorder dataRecorder) Stops recording of data.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.ControllerService

dispose, getContext, getController, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingService

public RecordingService()

Method Detail

startRecording

public abstract void startRecording(DataRecorder dataRecorder)

Starts recording of data. The DataRecorder must be enabled in order to start the recording process. Enabled means that the data recorder is ready to start recording. A disable process occurs automatically when the data recorder stops.

Parameters:

dataRecorder - the data recorder.

See Also:

#enable()

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.

stopRecording

public abstract void stopRecording(DataRecorder dataRecorder)

Stops recording of data. A disable process occurs automatically when the data recorder stops.

Parameters:

dataRecorder - the data recorder.

See Also:

#enable(), #startRecording()

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.

enableRecording

public abstract void enableRecording(DataRecorder dataRecorder,
                                     boolean hasTrigger)

Enables the data recorder. It does not start the recording process. Enabled means that the data recorder is ready to start recording. A disable process occurs automatically when the data recorder stops.

Parameters:

dataRecorder - the data recorder.

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

See Also:

#startRecording(), #stopRecording()

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.

isEnabled

public abstract boolean isEnabled()

Provides the information about whether the recording is enabled or not.

Returns:

true if recording is enabled, false otherwise.

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.

isRecording

public abstract boolean isRecording()

Provides the state of the recording process.

Returns:

true if recording process is active, false otherwise.

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.

getDefaultFileName

public abstract String getDefaultFileName(DataRecorder dataRecorder)

Provides the name of the file in which the data will be saved.

Parameters:

dataRecorder - the data recorder.

Returns:

The name of the file.

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.

getRecordingSPR

public abstract SPR getRecordingSPR(DataRecorder dataRecorder)

Provides the recording SPR in which the dataRecorder is running.

Parameters:

dataRecorder - the data recorder.

Returns:

The recording SPR if the dataRecorder has been enabled, null otherwise.

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.

startEvaluation

public abstract void startEvaluation(TorqueEvaluator torqueEvaluator)

Starts the torque statistic data evaluation.

Parameters:

torqueEvaluator - the corresponding torque evaluator.

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.

stopEvaluation

public abstract TorqueStatistic stopEvaluation(TorqueEvaluator torqueEvaluator)

Stops data evaluation and returns the desired statistic result.

Parameters:

torqueEvaluator - the corresponding torque evaluator.

Returns:

The torque statistic data.

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.

isEvaluating

public abstract boolean isEvaluating(TorqueEvaluator torqueEvaluator)

Provides the information about whether the statistic data are being evaluated now or not.

Parameters:

torqueEvaluator - the corresponding torque evaluator.

Returns:

true if evaluation process is active, false otherwise.

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.