com.kuka.roboticsAPI.applicationModel
Class ApplicationEngine

java.lang.Object
  com.kuka.roboticsAPI.AbstractEngine
      com.kuka.roboticsAPI.applicationModel.ApplicationEngine

All Implemented Interfaces:

IEngine

public class ApplicationEngine
extends AbstractEngine

Engine responsible for creating and disposing of application and task specific objects such as IApplicationControl, IApplicationData and ObserverManager.

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

ApplicationEngine(RoboticsAPIContext context, boolean createControl)
Creates an instance of the engine.

Method Summary

void	dispose() Disposes the engine.
IApplicationControl	getApplicationControl() Gets IApplicationControl implementation for the associated task.
IApplicationData	getApplicationData() Gets IApplicationData implementation for the associated task.
Class<? extends IEngine>	getEngineType() Gets the type of the engine.
ObserverManager	getObserverManager() Gets ObserverManager implementation for the associated task.
void	initialize() Initializes the engine.

Methods inherited from class com.kuka.roboticsAPI.AbstractEngine

getContext, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationEngine

public ApplicationEngine(RoboticsAPIContext context,
                         boolean createControl)

Creates an instance of the engine.

Parameters:

context - task/application context for which the engine is created.

createControl - if set to true - IApplicationControl-instance should be created (that means that the task associated with this engine is an application)

Method Detail

getEngineType

public Class<? extends IEngine> getEngineType()

Description copied from class: AbstractEngine

Gets the type of the engine. This should be the concrete IEngine interface which the engine is implementing.

Specified by:

getEngineType in interface IEngine

Specified by:

getEngineType in class AbstractEngine

Returns:

The type of the engine. This should be the concrete IEngine interface which the engine is implementing.

initialize

public void initialize()

Description copied from class: AbstractEngine

Initializes the engine. This method is automatically called by the engine context when it is initialized.

Specified by:

initialize in interface IEngine

Overrides:

initialize in class AbstractEngine

dispose

public void dispose()

Description copied from class: AbstractEngine

Disposes the engine. This method is automatically called by the engine context when it is disposed.

Specified by:

dispose in interface IEngine

Overrides:

dispose in class AbstractEngine

getApplicationData

public IApplicationData getApplicationData()

Gets IApplicationData implementation for the associated task.

Returns:

IApplicationData implementation for the associated task.

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.

getObserverManager

public ObserverManager getObserverManager()

Gets ObserverManager implementation for the associated task.

Returns:

ObserverManager implementation for the associated task.

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.

getApplicationControl

public IApplicationControl getApplicationControl()

Gets IApplicationControl implementation for the associated task.

Returns:

IApplicationControl implementation for the associated task. Can be null if the associated task is not an RPAI application.

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.