com.kuka.roboticsAPI
Class AbstractEngine

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

All Implemented Interfaces:

IEngine

Direct Known Subclasses:

ApplicationEngine, DeviceFactory, PersistenceEngine, SyncManager, UIEngine

public abstract class AbstractEngine
extends Object
implements IEngine

Base implementation of an 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.

Constructor Summary

protected

AbstractEngine(RoboticsAPIContext context) For subclasses.

Method Summary

void	dispose() Disposes the engine.
RoboticsAPIContext	getContext() Gets the context for this engine.
abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEngine

protected AbstractEngine(RoboticsAPIContext context)

For subclasses.

Subclasses should provide the same constructor with the same parameters, because this constructor is called by the RoboticsAPI through reflection.

Parameters:

context - The context for this controller. null is not allowed.

Method Detail

getEngineType

public abstract Class<? extends IEngine> getEngineType()

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

Specified by:

getEngineType in interface IEngine

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.

setParameters

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

Sets the parameters for this engine.

Specified by:

setParameters in interface IEngine

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.

dispose

public void dispose()

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

Specified by:

dispose in interface IEngine

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

public void initialize()

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

Specified by:

initialize in interface IEngine

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

public final RoboticsAPIContext getContext()

Gets the context for this engine.

Specified by:

getContext in interface IEngine

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.