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

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.SPR
      com.kuka.roboticsAPI.controllerModel.sunrise.xml.XmlSPR

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment

public class XmlSPR
extends SPR

A XmlSPR is created out of a xml representation in the file system. It behaves like a normal SPR after it was loaded. It also can be modified by the program.

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.controllerModel.sunrise.api.SPR

INVALID_SPR_ID

Constructor Summary

XmlSPR(String name)
Creates a new instance.

Method Summary

SPRComponent	getComponent(String moduleIdentifier) Finds the component which has the the given name.
static XmlSPR	load(RoboticsAPIContext context, String resourceName) Loads a xml spr from the given context from the given resource name.
static XmlSPR	load(RoboticsAPIContext context, String name, String resourceName) Loads a xml spr from the given context from the given resource name and with the given type name.
static XmlSPR	load(String name, String fileName) Loads a xml spr with the given type name from the given file location.
static XmlSPR	load(String sprName, URL url) Loads a xml spr with the given type name from the given location.
static XmlSPR	load(URL url) Loads a xml spr from the given url.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.api.SPR

addAssignment, addAssignment, addAssignment, addAssignment, addAssignment, addInterSprAssignment, addLooseAssignment, addLooseAssignment, addLooseAssignment, addModule, addSelectiveAssignment, addSelectiveAssignment, addSelectiveAssignment, addStopCondition, addStopCondition, canHandleSafetyStopRequest, getActiveDevice, getAssignmentByInPort, getAssignmentByInPort, getAssignments, getDefaultAssignments, getDescription, getDeviceName, getExpressionSegmentString, getFrameDefinitions, getGlobalDataServiceModule, getLayerAttachment, getModule, getModule, getModules, getModules, getPublishedPorts, getReturnValues, getRuntime, getSelection, getSelectionModule, getSelections, getSPRInfoString, getStackDescription, getStackTypeName, getStopConditions, getTypeName, hasModule, hasSameDataAs, hasStopConditions, isPortPublished, onFinished, onSerialization, publishPort, registerForReturnValues, registerForReturnValues, registerForReturnValuesIfUnregistered, removeAssignment, removeDefaultAssignment, setActiveDevice, setActiveDevice, setCanHandleSafetyStopRequest, setDescription, setDeviceName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlSPR

public XmlSPR(String name)

Creates a new instance.

Parameters:

name - The type name of the spr.

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

getComponent

public final SPRComponent getComponent(String moduleIdentifier)

Finds the component which has the the given name.

This method also checks the instance name and the alias of all components.

Parameters:

moduleIdentifier - The name to search for.

Returns:

The compound in this SPR with the specified instance name.

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.

load

public static XmlSPR load(RoboticsAPIContext context,
                          String resourceName)

Loads a xml spr from the given context from the given resource name.

Parameters:

context - The context.

resourceName - The resource name.

Returns:

The generated xml spr.

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.

load

public static XmlSPR load(RoboticsAPIContext context,
                          String name,
                          String resourceName)

Loads a xml spr from the given context from the given resource name and with the given type name.

Parameters:

context - The context.

name - The type name of the spr.

resourceName - The resource name.

Returns:

The generated xml spr.

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.

load

public static XmlSPR load(URL url)

Loads a xml spr from the given url.

Parameters:

url - The url where the xml spr description can be found.

Returns:

The generated xml spr.

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.

load

public static XmlSPR load(String name,
                          String fileName)
                   throws MalformedURLException

Loads a xml spr with the given type name from the given file location.

Parameters:

name - The type name of the spr.

fileName - The file name of the xml spr description.

Returns:

The generated xml spr.

Throws:

MalformedURLException - Thrown when the given fileName is not a valid URL.

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.

load

public static XmlSPR load(String sprName,
                          URL url)

Loads a xml spr with the given type name from the given location.

Parameters:

sprName - The type name of the spr.

url - The location of the content which describes the spr which should be created.

Returns:

The generated xml spr.

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.