com.kuka.roboticsAPI
Class RoboticsAPILazyDeviceContext

java.lang.Object
  com.kuka.roboticsAPI.RoboticsAPIContext
      com.kuka.roboticsAPI.RoboticsAPILazyDeviceContext

All Implemented Interfaces:

IFinalizableObject

public class RoboticsAPILazyDeviceContext
extends RoboticsAPIContext

Device context that initializes the controllers on demand.

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.

Field Summary

Fields inherited from class com.kuka.roboticsAPI.RoboticsAPIContext

_controllers, DEFAULT_FILE_NAME

Constructor Summary

protected

RoboticsAPILazyDeviceContext(Class<?> applicationContext, URL configFile) Creates a new context instance.

Method Summary

boolean	controllersInitialized() indicates whether the controller is initialized.
static RoboticsAPILazyDeviceContext	create() Creates a new RoboticsAPIContext out of the config file which is located on the default package scope.
static RoboticsAPILazyDeviceContext	create(Class<?> applicationContext) Creates a new RoboticsAPIContext out of the config file which is located on the default package scope.
static RoboticsAPILazyDeviceContext	createFromFile(Class<?> applicationContext, File configFile) Creates a new RoboticsAPIContext out of the given config file.
static RoboticsAPILazyDeviceContext	createFromFile(File configFile) Creates a new RoboticsAPIContext out of the given config file.
static RoboticsAPILazyDeviceContext	createFromResource(Class<?> applicationContext, String resourceName) Creates a new RoboticsAPIContext out of the given configuration file.
static RoboticsAPILazyDeviceContext	createFromResource(String resourceName) Creates a new RoboticsAPIContext out of the given configuration file.
static RoboticsAPILazyDeviceContext	createFromURL(Class<?> applicationContext, URL configURL) Creates a new RoboticsAPIContext out of the given config URL.
void	dispose() Disposes this context and all included resources.
BootStateControllerInitializationBehaviour	getControllerInitializeBehavior() Gets the initialization behavior of the controller.
void	initializeControllers() Initialize the controller.
protected Controller	loadControllers(Iterable<com.kuka.common.ParameterSet> descriptions, Map<String,Controller> controllers, Map<String,com.kuka.common.ParameterSet> invalidControllers) Loads all controllers from the parameter set descriptions.

Methods inherited from class com.kuka.roboticsAPI.RoboticsAPIContext

addContextListener, containsController, containsEngine, createController, createDefaultContext, createInstance, dumpDevices, finalizeObject, getApplicationClass, getConfigurationFile, getController, getControllers, getDefaultController, getDeviceFactory, getDeviceFromName, getDeviceFromName, getDeviceFromType, getEngine, getInvalidControllers, getInvalidEngines, getSyncManager, initialize, isInitialized, loadClass, registerEngine, removeContextListener, resolve, setFirstController, toString, tryGetEngine, tryResolve, useGracefulInitialization, usingGracefulInitialization

Methods inherited from class java.lang.Object

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

Constructor Detail

RoboticsAPILazyDeviceContext

protected RoboticsAPILazyDeviceContext(Class<?> applicationContext,
                                       URL configFile)

Creates a new context instance.

Parameters:

applicationContext - The application context. Can be null.

configFile - The configuration file. Can be null.

Method Detail

initializeControllers

public void initializeControllers()

Initialize the controller.

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.

controllersInitialized

public boolean controllersInitialized()

indicates whether the controller is initialized.

Returns:

true if controller is initialized.

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.

loadControllers

protected Controller loadControllers(Iterable<com.kuka.common.ParameterSet> descriptions,
                                     Map<String,Controller> controllers,
                                     Map<String,com.kuka.common.ParameterSet> invalidControllers)

Description copied from class: RoboticsAPIContext

Loads all controllers from the parameter set descriptions.

Overrides:

loadControllers in class RoboticsAPIContext

Parameters:

descriptions - The set of descriptions. The "Class"-Attribute describes the type of the controller, the "Name" attribute the name.

controllers - The map in which the created controllers should get added.

invalidControllers - The map in which invalid controllers should get added (if graceful initialization is on).

Returns:

The first created controller which will be the default controller for the context.

create

public static RoboticsAPILazyDeviceContext create()

Creates a new RoboticsAPIContext out of the config file which is located on the default package scope. The config file must have the name 'RoboticsAPI.config.xml'.

Returns:

The RoboticsAPIContext instance.

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.

create

public static RoboticsAPILazyDeviceContext create(Class<?> applicationContext)

Creates a new RoboticsAPIContext out of the config file which is located on the default package scope. The config file must have the name 'RoboticsAPI.config.xml'.

Parameters:

applicationContext - The application context.

Returns:

The RoboticsAPIContext instance.

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.

createFromResource

public static RoboticsAPILazyDeviceContext createFromResource(String resourceName)

Creates a new RoboticsAPIContext out of the given configuration file. This file has to be locatable by the Utilities.resolve method. If a configuration was already loaded for this config file, this instance will be disposed first.

Parameters:

resourceName - The resource file. null is not allowed.

Returns:

The RoboticsAPIContext instance.

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.

createFromResource

public static RoboticsAPILazyDeviceContext createFromResource(Class<?> applicationContext,
                                                              String resourceName)

Creates a new RoboticsAPIContext out of the given configuration file. This file has to be locatable by the Utilities.resolve method. If a configuration was already loaded for this config file, this instance will be disposed first.

Parameters:

applicationContext - The application context.

resourceName - The resource file. null is not allowed.

Returns:

The RoboticsAPIContext instance.

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.

createFromFile

public static RoboticsAPILazyDeviceContext createFromFile(File configFile)

Creates a new RoboticsAPIContext out of the given config file. The URL of the file will be used to load the context.

Parameters:

configFile - The config file. null is not allowed.

Returns:

The RoboticsAPIContext instance.

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.

createFromFile

public static RoboticsAPILazyDeviceContext createFromFile(Class<?> applicationContext,
                                                          File configFile)

Creates a new RoboticsAPIContext out of the given config file. The URL of the file will be used to load the context.

Parameters:

applicationContext - The application context.

configFile - The config file. null is not allowed.

Returns:

The RoboticsAPIContext instance.

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.

createFromURL

public static RoboticsAPILazyDeviceContext createFromURL(Class<?> applicationContext,
                                                         URL configURL)

Creates a new RoboticsAPIContext out of the given config URL.

Parameters:

applicationContext - The application context.

configURL - The URL to the config file. null is not allowed.

Returns:

The RoboticsAPIContext instance.

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.

dispose

public void dispose()

Disposes this context and all included resources.

Overrides:

dispose in class RoboticsAPIContext

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.

getControllerInitializeBehavior

public BootStateControllerInitializationBehaviour getControllerInitializeBehavior()

Gets the initialization behavior of the controller. The LazyDevice RoboticsAPIContext defines an initialization behavior handling the boot states of the controller.

Overrides:

getControllerInitializeBehavior in class RoboticsAPIContext

Returns:

the initialization behavior of the controller.

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.