A C D E F G I L O P R S T V W

A

addStateListener(ITaskInstanceStateListener) - Method in interface com.kuka.task.ITaskInstance
Adds a listener for the user task's TaskState changes.
AmbiguousInstanceException - Exception in com.kuka.task
Is thrown when a task function is requested for a task that allows multiple instances to be spawned without specifying the concrete instance.
AmbiguousInstanceException(Class<?>) - Constructor for exception com.kuka.task.AmbiguousInstanceException
Constructs a new exception with the specified parameters.
AmbiguousInstanceException(String, Class<?>) - Constructor for exception com.kuka.task.AmbiguousInstanceException
Constructs a new exception with the specified parameters.
await() - Method in interface com.kuka.task.ITaskFunctionMonitor
Blocks and waits for an unspecified amount of time for the monitored function to become available, while being interruptible by Thread.interrupt().
await(long, TimeUnit) - Method in interface com.kuka.task.ITaskFunctionMonitor
Blocks and waits for the given amount of time for the monitored function to become available, while being interruptible by Thread.interrupt().

C

com.kuka.task - package com.kuka.task
Contains interfaces and classes needed for tasks using RoboticsAPI.
com.kuka.task.properties - package com.kuka.task.properties
This package contains interfaces to describe application properties.
create(Object) - Static method in class com.kuka.task.TaskFunctionMonitor
Returns a monitor for the given task function instance that allows you to query or wait on the availability of the task function (remember that a task function is only available as long as the task that is providing the function is running).

D

dispose() - Method in interface com.kuka.task.IRoboticsAPITask
Will be called when the task is about to be disposed, for example if the task is being asked to stop.
dispose() - Method in class com.kuka.task.RoboticsAPITask
 

E

error(String) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with ERROR level.
error(String, Throwable) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with ERROR level, with associated Throwable information.

F

fine(String) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with FINE level.
FunctionNotAvailableException - Exception in com.kuka.task
Is thrown when the requested task function is not known.
FunctionNotAvailableException(Class<?>) - Constructor for exception com.kuka.task.FunctionNotAvailableException
Constructs a new exception with the specified parameters.
FunctionNotAvailableException(Class<?>, ITaskInstance) - Constructor for exception com.kuka.task.FunctionNotAvailableException
Constructs a new exception with the specified parameters.

G

getError() - Method in interface com.kuka.task.ITaskInstance
Gets the exception which caused termination of the task instance.
getFunction() - Method in exception com.kuka.task.FunctionNotAvailableException
Returns the requested function causing this exception.
getFunctionType() - Method in exception com.kuka.task.InstanceNotRunningException
Returns the task function that caused the exception.
getInstances() - Method in interface com.kuka.task.ITask
Gets all running instances of the task.
getMessage() - Method in exception com.kuka.task.AmbiguousInstanceException
 
getMessage() - Method in exception com.kuka.task.FunctionNotAvailableException
 
getMessage() - Method in exception com.kuka.task.InstanceNotRunningException
 
getParameters() - Method in interface com.kuka.task.ITaskInstance
Gets all parameters with which the instance was started.
getTask(Class<?>) - Method in interface com.kuka.task.ITaskManager
Returns the ITask for the requested task.
getTaskFunction(Class<F>) - Method in interface com.kuka.task.ITask
Returns an instance of the type represented by the given task function class that allows access to the task function provided by an instance of this task.
getTaskFunction(Class<F>) - Method in interface com.kuka.task.ITaskInstance
Returns an instance of the type represented by the given task function class that allows access to the task function provided this task instance.
getTaskFunction(Class<F>) - Method in interface com.kuka.task.ITaskManager
Returns an instance of the type represented by the given task function class that allows access to the task function provided by an instance of one of the registered tasks.
getTaskType() - Method in exception com.kuka.task.AmbiguousInstanceException
Returns the task type that caused the exception.

I

IllegalTaskStateException - Exception in com.kuka.task
Signals that a method has been invoked on a task instance while it was in an inappropriate state.
IllegalTaskStateException(String) - Constructor for exception com.kuka.task.IllegalTaskStateException
Constructs a new exception with an error message.
info(String) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with INFO level.
initialize() - Method in interface com.kuka.task.IRoboticsAPITask
Will be called when the task is initialized.
initialize() - Method in class com.kuka.task.RoboticsAPITask
 
InstanceNotRunningException - Exception in com.kuka.task
Is thrown when a task function is requested for a task that allows multiple instances to be spawned without specifying the concrete instance.
InstanceNotRunningException(Class<?>) - Constructor for exception com.kuka.task.InstanceNotRunningException
Constructs a new exception with the specified parameters.
IRoboticsAPITask - Interface in com.kuka.task
Basic task interface.
isActive() - Method in enum com.kuka.task.TaskState
Indicates whether the task state is an active state.
isAvailable() - Method in interface com.kuka.task.ITaskFunctionMonitor
Checks if the monitored task function is available at the moment.
isFinished() - Method in enum com.kuka.task.TaskState
Indicates whether the task state is a finished state (TaskState.STOPPED or TaskState.ERROR).
isStartable() - Method in enum com.kuka.task.TaskState
Indicates whether a task instance is startable in this state.
isStopping() - Method in enum com.kuka.task.TaskState
Indicates whether the task state is a stopping state.
ITask - Interface in com.kuka.task
Represents a task control interface that can be used in other tasks.
ITaskFunctionMonitor - Interface in com.kuka.task
Interface to monitor the presence of a task function, which is only available as long as the providing task instance is running.
ITaskInstance - Interface in com.kuka.task
Task instance representation.
ITaskInstanceStateListener - Interface in com.kuka.task
State listener interface for ITaskInstance state changes.
ITaskLogger - Interface in com.kuka.task
RoboticsAPI logging interface to be used by tasks.
ITaskManager - Interface in com.kuka.task
Task manager.

L

LockUsedResources - Annotation Type in com.kuka.task.properties
A task using this annotation will have all its used resources being locked during initialization.

O

onStateChanged(ITaskInstance, TaskState, TaskState) - Method in interface com.kuka.task.ITaskInstanceStateListener
This event is called when a ITaskInstance exits one TaskState and enters another.

P

ParameterSetter - Annotation Type in com.kuka.task.properties
Declares the function to the function where to set the parameters.

R

removeStateListener(ITaskInstanceStateListener) - Method in interface com.kuka.task.ITaskInstance
Unregisters a TaskState change event listener.
RoboticsAPITask - Class in com.kuka.task
Base class for RoboticsAPI tasks.
RoboticsAPITask() - Constructor for class com.kuka.task.RoboticsAPITask
 
run() - Method in interface com.kuka.task.IRoboticsAPITask
Will be called to run the task after it has been initialized.

S

startInstance(Object...) - Method in interface com.kuka.task.ITask
Starts a new instance of the corresponding task with the specified parameters.
stopAllInstances() - Method in interface com.kuka.task.ITask
Stops all running instances of this task.
stopInstance(ITaskInstance) - Method in interface com.kuka.task.ITask
Stops the given task instance which was previously started by ITask.startInstance(Object...).

T

TaskException - Exception in com.kuka.task
Base class for checked exceptions thrown during task handling.
TaskException() - Constructor for exception com.kuka.task.TaskException
Constructs a new exception with null as its detail message.
TaskException(String) - Constructor for exception com.kuka.task.TaskException
Constructs a new exception with the specified detail message.
TaskException(Throwable) - Constructor for exception com.kuka.task.TaskException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskException(String, Throwable) - Constructor for exception com.kuka.task.TaskException
Constructs a new exception with the specified detail message and cause.
TaskFunctionMonitor - Class in com.kuka.task
This class allows to create an ITaskFunctionMonitor that can query and await the availability of task functions.
TaskFunctionProvider - Annotation Type in com.kuka.task.properties
Annotates methods that provide an TaskFunction.
TaskInitializationException - Exception in com.kuka.task
Exception thrown by deployment errors.
TaskInitializationException() - Constructor for exception com.kuka.task.TaskInitializationException
Constructs a new exception with null as its detail message.
TaskInitializationException(String) - Constructor for exception com.kuka.task.TaskInitializationException
Constructs a new exception with the specified detail message.
TaskInitializationException(Throwable) - Constructor for exception com.kuka.task.TaskInitializationException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskInitializationException(String, Throwable) - Constructor for exception com.kuka.task.TaskInitializationException
Constructs a new exception with the specified detail message and cause.
TaskInstanceNotAvailableException - Exception in com.kuka.task
Exception thrown when a query is made for a ITaskInstance but there is no instance available to satisfy the query.
TaskInstanceNotAvailableException(String) - Constructor for exception com.kuka.task.TaskInstanceNotAvailableException
Constructs a new exception with the specified detail message.
TaskInstanceNotAvailableException(Throwable) - Constructor for exception com.kuka.task.TaskInstanceNotAvailableException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskInstanceNotAvailableException(String, Throwable) - Constructor for exception com.kuka.task.TaskInstanceNotAvailableException
Constructs a new exception with the specified detail message and cause.
TaskLockPriority - Annotation Type in com.kuka.task.properties
Defines priority level at which the annotated task can lock resources.
TaskNotAvailableException - Exception in com.kuka.task
Exception thrown when a task not available at the task manager.
TaskNotAvailableException(String) - Constructor for exception com.kuka.task.TaskNotAvailableException
Constructs a new exception with the specified detail message.
TaskNotAvailableException(Throwable) - Constructor for exception com.kuka.task.TaskNotAvailableException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskNotAvailableException(String, Throwable) - Constructor for exception com.kuka.task.TaskNotAvailableException
Constructs a new exception with the specified detail message and cause.
TaskRuntimeException - Exception in com.kuka.task
Base class for unchecked exceptions that can occur during task handling.
TaskRuntimeException() - Constructor for exception com.kuka.task.TaskRuntimeException
constructs a new exception.
TaskRuntimeException(String) - Constructor for exception com.kuka.task.TaskRuntimeException
Constructor with an error message.
TaskRuntimeException(String, Throwable) - Constructor for exception com.kuka.task.TaskRuntimeException
Constructs a new exception with the specified detail message and cause.
TaskRuntimeException(Throwable) - Constructor for exception com.kuka.task.TaskRuntimeException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskRuntimeInitializationException - Exception in com.kuka.task
Exception thrown by deployment errors.
TaskRuntimeInitializationException() - Constructor for exception com.kuka.task.TaskRuntimeInitializationException
constructs a new exception.
TaskRuntimeInitializationException(String, Throwable) - Constructor for exception com.kuka.task.TaskRuntimeInitializationException
Constructs a new deployment exception with the specified detail message and cause.
TaskRuntimeInitializationException(String) - Constructor for exception com.kuka.task.TaskRuntimeInitializationException
Constructs a new deployment exception with the specified detail message.
TaskRuntimeInitializationException(Throwable) - Constructor for exception com.kuka.task.TaskRuntimeInitializationException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
TaskState - Enum in com.kuka.task
Represents the state of a task instance.
TemplateInstanceCreationException - Exception in com.kuka.task
Exception on instance creation from template data.
TemplateInstanceCreationException(String) - Constructor for exception com.kuka.task.TemplateInstanceCreationException
Constructs a new exception with the specified detail message.
TemplateInstanceCreationException(String, Throwable) - Constructor for exception com.kuka.task.TemplateInstanceCreationException
Constructs a new exception with the specified detail message and cause.
TemplateInstanceCreationException(Throwable) - Constructor for exception com.kuka.task.TemplateInstanceCreationException
Constructs a new exception with the specified cause and a detail message of (cause==null ?
toString() - Method in exception com.kuka.task.InstanceNotRunningException
 

V

valueOf(String) - Static method in enum com.kuka.task.TaskState
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.kuka.task.TaskState
Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with WARNING level.
warn(String, Throwable) - Method in interface com.kuka.task.ITaskLogger
Logs the given message with WARNING level, with associated Throwable information.

A C D E F G I L O P R S T V W

Copyright © 2019. All rights reserved.