com.kuka.roboticsAPI.applicationModel.tasks
Class RoboticsAPIBackgroundTask

java.lang.Object
  com.kuka.roboticsAPI.applicationModel.tasks.RoboticsAPITask
      com.kuka.roboticsAPI.applicationModel.tasks.RoboticsAPIBackgroundTask

All Implemented Interfaces:

ILegacyRoboticsAPITask, com.kuka.task.IRoboticsAPITask

Direct Known Subclasses:

RoboticsAPICyclicBackgroundTask

public abstract class RoboticsAPIBackgroundTask
extends RoboticsAPITask
implements ILegacyRoboticsAPITask

Base class for RoboticsAPI background task.

This element is not in its final state and might change in future versions.

Constructor Summary

protected	RoboticsAPIBackgroundTask() This constructor is meant to be used with dependency injection.
protected	RoboticsAPIBackgroundTask(RoboticsAPIContext context) Creates a new instance of the task with specified context, without logging or task manager capabilities.
protected	RoboticsAPIBackgroundTask(RoboticsAPIContext context, com.kuka.task.ITaskLogger logger, com.kuka.task.ITaskManager taskManager) Creates a new instance of the task with specified context.

Method Summary

ITaskUI

getApplicationUI() Gets the application UI interface for the background task.

Methods inherited from class com.kuka.roboticsAPI.applicationModel.tasks.RoboticsAPITask

dispose, getApplicationData, getContext, getController, getDevice, getDevice, getLogger, getObserverManager, getRecovery, getRobot, getRobot, getTaskFunction, getTaskManager, initialize

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.applicationModel.tasks.ILegacyRoboticsAPITask

getContext, getLogger

Methods inherited from interface com.kuka.task.IRoboticsAPITask

dispose, initialize, run

Constructor Detail

RoboticsAPIBackgroundTask

protected RoboticsAPIBackgroundTask()

This constructor is meant to be used with dependency injection. When using this constructor, the class depends on fields to be injected.

RoboticsAPIBackgroundTask

protected RoboticsAPIBackgroundTask(RoboticsAPIContext context)

Creates a new instance of the task with specified context, without logging or task manager capabilities. The application will not be able to use logging (RoboticsAPITask.getLogger() or the task manager (RoboticsAPITask.getTaskManager() and RoboticsAPITask.getTaskFunction(Class)).

Parameters:

context - context of the task. It will be disposed when this task is disposed.

RoboticsAPIBackgroundTask

protected RoboticsAPIBackgroundTask(RoboticsAPIContext context,
                                    com.kuka.task.ITaskLogger logger,
                                    com.kuka.task.ITaskManager taskManager)

Creates a new instance of the task with specified context.

Parameters:

context - context of the task. It will be disposed when this task is disposed.

logger - the logger that will be returned by RoboticsAPITask.getLogger()

taskManager - the task manager that will be returned by RoboticsAPITask.getTaskManager() and is used by RoboticsAPITask.getTaskFunction(Class)

Method Detail

getApplicationUI

public ITaskUI getApplicationUI()

Gets the application UI interface for the background task.

Overrides:

getApplicationUI in class RoboticsAPITask

Returns:

the application UI interface for the background task.

Throws:

IllegalArgumentException - if UI engine is not configured for the background task.