com.kuka.roboticsAPI
Interface IEngine

All Known Subinterfaces:

IDeviceFactory, IPersistenceEngine, ISyncManager, IUIEngine

All Known Implementing Classes:

AbstractEngine, ApplicationEngine, DeviceFactory, PersistenceEngine, RecoveryEngine, SyncManager, UIEngine

public interface IEngine

Interface describing an engine in the RoboticsAPI. Each engine implementation must provide a public constructor with one argument of the type 'RoboticsAPIContext'. Otherwise, it is not usable within a RoboticsAPIContext. For this purpose, engines may subclass 'AbstractEngine' which provides such a constructor.

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.

Method Summary

void	dispose() Disposes the engine.
RoboticsAPIContext	getContext() Gets the context for this engine.
Class<? extends IEngine>	getEngineType() Gets the type of the engine.
void	initialize() Initializes the engine.
void	setParameters(com.kuka.common.ParameterSet parameters) Sets the parameters for this engine.

Method Detail

getEngineType

Class<? extends IEngine> getEngineType()

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

Returns:

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

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

void dispose()

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

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.

initialize

void initialize()

Initializes the engine. This method is automatically called by the engine context when it 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.

getContext

RoboticsAPIContext getContext()

Gets the context for this engine.

Returns:

The context for this engine.

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.

setParameters

void setParameters(com.kuka.common.ParameterSet parameters)

Sets the parameters for this engine.

Parameters:

parameters - The parameters for this engine.

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.