com.kuka.roboticsAPI.controllerModel.sunrise
Class SunriseRecordingService

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

public class SunriseRecordingService
extends RecordingService

Sunrise service class for data recording and statistic calculation.

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

SunriseRecordingService()

Method Summary

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

SunriseRecordingService

public SunriseRecordingService()

Method Detail

startRecording

public 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.

Specified by:

startRecording in class RecordingService

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.

enableRecording

public void enableRecording(DataRecorder dataRecorder,
                            boolean hasTrigger)

Description copied from class: RecordingService

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.

Specified by:

enableRecording in class RecordingService

Parameters:

dataRecorder - the data recorder.

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

See Also:

#startRecording(), #stopRecording()

stopRecording

public void stopRecording(DataRecorder dataRecorder)

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

Specified by:

stopRecording in class RecordingService

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.

getRecordingCommand

public SunriseRecordingCommand getRecordingCommand(DataRecorder dataRecorder)

Gets the underlying recording command.

Parameters:

dataRecorder - DataRecorder to get the command for.

Returns:

the underlying recording command when the currently used DataRecorder is the given one, otherwise 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.

getDefaultFileName

public String getDefaultFileName(DataRecorder dataRecorder)

Description copied from class: RecordingService

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

Specified by:

getDefaultFileName in class RecordingService

Parameters:

dataRecorder - the data recorder.

Returns:

The name of the file.

isEnabled

public boolean isEnabled()

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

Specified by:

isEnabled in class RecordingService

Returns:

true if the SPR-state of the data recording SPR is at least SPRState.Preparing but not SPRState.Maintaining or further yet, 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 boolean isRecording()

Provides the state of the recording process.

Specified by:

isRecording in class RecordingService

Returns:

true if the SPR-state of the data recording SPR is SPRState.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.

getRecordingSPR

public SPR getRecordingSPR(DataRecorder dataRecorder)

Provides the recording SPR in which the dataRecorder is running.

Specified by:

getRecordingSPR in class RecordingService

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 void startEvaluation(TorqueEvaluator torqueEvaluator)

Description copied from class: RecordingService

Starts the torque statistic data evaluation.

Specified by:

startEvaluation in class RecordingService

Parameters:

torqueEvaluator - the corresponding torque evaluator.

stopEvaluation

public TorqueStatistic stopEvaluation(TorqueEvaluator torqueEvaluator)

Description copied from class: RecordingService

Stops data evaluation and returns the desired statistic result.

Specified by:

stopEvaluation in class RecordingService

Parameters:

torqueEvaluator - the corresponding torque evaluator.

Returns:

The torque statistic data.

isEvaluating

public boolean isEvaluating(TorqueEvaluator torqueEvaluator)

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

Specified by:

isEvaluating in class RecordingService

Parameters:

torqueEvaluator - the corresponding torque evaluator.

Returns:

true if the SPR-state of the data statistic SPR is SPRState.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.