com.kuka.roboticsAPI.applicationModel.tasks
Annotation Type UseRoboticsAPIContext

@Retention(value=RUNTIME)
@Target(value=TYPE)
@Inherited
public @interface UseRoboticsAPIContext

When a task class is annotated with this annotation, the task and it's injected dependencies will be able to use the following types using dependency injection (using @Inject, @Named etc.):

• General purpose types:
  • LBR*
  • Robot*
  • Tool*
  • Workpiece** : Non-singleton, unless the type is annotated with @Singleton
  • IProcessData**
• Control types:
  • IApplicationData
  • IApplicationUI
  • ITaskLogger
  • IApplicationControl
  • IApplicationOverrideControl
  • ObserverManager
• User defined types:
  • All custom tool types that are configured in the application template data and referenced by the template class property.
  • All custom workpiece types that are configured in the application template data and referenced by the template class property. Non-singleton, unless the type is annotated with @Singleton.
• Generated IO-Groups:
• All generated IO-Group types. Every IO-Group type will be injected as Singleton.
• Special purpose types (use only if you know what you're doing):
  • Device*
  • Controller*
  • SunriseController*
  • IRecovery
  • IApplicationDataSource
  • ISaveableApplicationDataSource
  • RoboticsAPIContext

Notes:
*: If there's more than one device or controller configured in the station, you must specify the name with a @Named. If devices names are not unique in the station (devices with the same name on several controllers), it is possible to use the following notation controllerName/deviceName as parameter for @Named .
**: The respective name or ID must be given with @Named

A non-singleton type will create a new instance of the type on each injection. Typically, you will use the following construct:

 @Inject Provider<TYPE> typeProvider;
 ...
 TYPE instance1 = typeProvider.get();
 TYPE instance2 = typeProvider.get();
 

This annotation will cause the creation of a RoboticsAPIContext instance whenever the task is instantiated on the application server.

Optional Element Summary

String

configFileUrl The resource URL of the RoboticsAPI configuration file, relative to the task class, as used in Class.getResource(String).

configFileUrl

public abstract String configFileUrl

The resource URL of the RoboticsAPI configuration file, relative to the task class, as used in Class.getResource(String). Defaults to .

Default:

"RoboticsAPI.config.xml"