com.kuka.roboticsAPI.controllerModel.sunrise.xml
Class XmlRuntime

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.xml.XmlRuntime

public class XmlRuntime
extends Object

The XmlRuntime loads SPRs from a file and executes the runtime tag contained in that XmlFile. Therefore it may be used as replacement of the XmlSUA application.

Constructor Summary

XmlRuntime(String resourceName, SunriseExecutionService executor)
Creates a new XmlRuntime class.

XmlRuntime(String resourceName, SunriseExecutionService executor, IReactionListener listener)
Creates a new XmlRuntime class.

XmlRuntime(URL url, SunriseExecutionService executor)
Creates a new XmlRuntime class.

XmlRuntime(URL url, SunriseExecutionService executor, IReactionListener listener)
Creates a new XmlRuntime class.

Method Summary

void	execute() Executes the runtime items specified in the file.
static XmlRuntime	execute(URL resourceUrl, SunriseExecutionService executor) Creates a new XmlRuntime and starts it immediately.
SunriseExecutionService	getExecutionService() Gets the execution service for this runtime.
Iterable<com.kuka.roboticsAPI.controllerModel.sunrise.xml.RuntimeItem>	getRuntimeItems() Gets the runtime items which are contained in this runtime.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRuntime

public XmlRuntime(String resourceName,
                  SunriseExecutionService executor)

Creates a new XmlRuntime class. After the runtime was created, you must call 'execute' to start the SPRs.

Parameters:

resourceName - The resource file which will get parsed.

executor - The executor to which the SPRs will get directed.

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.

XmlRuntime

public XmlRuntime(String resourceName,
                  SunriseExecutionService executor,
                  IReactionListener listener)

Creates a new XmlRuntime class. After the runtime was created, you must call 'execute' to start the SPRs.

Parameters:

resourceName - The resource file which will get parsed.

executor - The executor to which the SPRs will get directed.

listener - The listener which get's called when a SPR has finished.

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.

XmlRuntime

public XmlRuntime(URL url,
                  SunriseExecutionService executor)

Creates a new XmlRuntime class. After the runtime was created, you must call 'execute' to start the SPRs.

Parameters:

url - The URL which will get parsed.

executor - The executor to which the SPRs will get directed.

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.

XmlRuntime

public XmlRuntime(URL url,
                  SunriseExecutionService executor,
                  IReactionListener listener)

Creates a new XmlRuntime class. After the runtime was created, you must call 'execute' to start the SPRs.

Parameters:

url - The URL which will get parsed.

executor - The executor to which the SPRs will get directed.

listener - The listener which get's called when a SPR has finished.

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 Detail

execute

public static XmlRuntime execute(URL resourceUrl,
                                 SunriseExecutionService executor)

Creates a new XmlRuntime and starts it immediately.

Parameters:

resourceUrl - The resource which will get parsed.

executor - The executor to which the SPRs will get directed.

Returns:

The runtime which was used during the execute process.

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.

getExecutionService

public SunriseExecutionService getExecutionService()

Gets the execution service for this runtime.

Returns:

The execution service for this runtime.

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.

execute

public void execute()

Executes the runtime items specified in the file.

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.

getRuntimeItems

public Iterable<com.kuka.roboticsAPI.controllerModel.sunrise.xml.RuntimeItem> getRuntimeItems()

Gets the runtime items which are contained in this runtime.

Returns:

The runtime items which are contained in this runtime.

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.