com.kuka.roboticsAPI.controllerModel.sunrise.api
Class SPR

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment

Direct Known Subclasses:

XmlSPR

public class SPR
extends Object
implements com.kuka.common.IDataEquatable, IExpressionSegment

A SPR is a data structure which represents a Sunrise Primitive Record.

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

static long

INVALID_SPR_ID SPR ID synonymous with "invalid SPR".

Constructor Summary

SPR(String typeName)
Creates a new instance with the given type name.

SPR(String typeName, int layer, String deviceName)
Creates a new instance of layered with the given type name and description.

SPR(String typeName, String deviceName)
Creates a new instance with the given type name for a device and on the default layer.

Method Summary

Assignment	addAssignment(Assignment assignment) Adds an assignment to this SPR.
DefaultAssignment	addAssignment(DefaultAssignment assignment) Adds the default assignment to this SPR.
Assignment	addAssignment(InPort inport, OutPort outport) Adds an assignment to this SPR.
DefaultAssignment	addAssignment(SPRComponent destination, SPRComponent source) Adds a new default assignment to this SPR connecting the leftInportsCompound (the compound with the inports) with the rightOutportsCompound (the compound with the outports).
Assignment	addAssignment(SPRComponent destination, String inportName, SPRComponent source, String outportName) Adds an assignment to this SPR.
Assignment	addInterSprAssignment(InPort inport, OutPort outport) Adds assignment between ports belonging to compounds from different SPRs.
Assignment	addLooseAssignment(InPort inport, OutPort outport) Adds an intercyclic (loose) assignment to this SPR.
DefaultAssignment	addLooseAssignment(SPRComponent destination, SPRComponent source) Adds a new intercyclic (loose) default assignment to this SPR connecting the leftInportsCompound (the compound with the inports) with the rightOutportsCompound (the compound with the outports).
Assignment	addLooseAssignment(SPRComponent destination, String inportName, SPRComponent source, String outportName) Adds an intercyclic (loose) assignment to this SPR.
void	addModule(Module module) Adds a compound to this SPR.
SelectiveAssignment	addSelectiveAssignment(int selectionLevel, InPort inport, OutPort outport) Adds an selective assignment to this SPR.
SelectiveAssignment	addSelectiveAssignment(int selectionLevel, SPRComponent left, String inportName, SPRComponent right, String outportName) Adds an selective assignment to this SPR.
SelectiveAssignment	addSelectiveAssignment(SelectiveAssignment assignment) Adds an selective assignment to this SPR.
SunriseStopCondition	addStopCondition(String stopConditionExpression) Adds a stop condition to this SPR.
SunriseStopCondition	addStopCondition(SunriseStopCondition stopCondition) Adds a stop condition to this SPR.
boolean	canHandleSafetyStopRequest() Returns true if this SPR can handle safety StopRequest and will not be automatically cancelled by Sunrise when a StopRequest is signaled.
ActiveDevice	getActiveDevice() Gets the active device for this SPR.
Assignment	getAssignmentByInPort(InPort inPort) Gets the assignment with the specified input port.
Assignment	getAssignmentByInPort(String componentInstanceName, String portName) Gets the assignment with the specified input port.
Iterable<Assignment>	getAssignments() Gets all assignments.
Iterable<DefaultAssignment>	getDefaultAssignments() Gets all default assignments.
String	getDescription() Gets the SPR description.
String	getDeviceName() Gets the name of the device with which this SPR associated.
String	getExpressionSegmentString(String tag) Gets the runtime value of an expression segment.
FrameDefinitionList	getFrameDefinitions() Gets the frame definitions of this SPR.
GlobalDataServiceModule	getGlobalDataServiceModule() Gets instance of GlobalDataServiceModule used for this SPR.
int	getLayerAttachment() Gets the layer attachment.
<T extends Module> T	getModule(Class<T> clazz) Gets the first module of the specified type.
Module	getModule(String name) Gets the module of the given name.
Iterable<Module>	getModules() Gets all modules.
<T extends Module> Iterable<T>	getModules(Class<T> clazz) Gets the all modules of the specified type.
Map<String,Port>	getPublishedPorts() Gets a list of all published ports of this SPR.
ReturnValues	getReturnValues() Gets all return values.
SPRRuntime	getRuntime() Gets the runtime class associated with this SPR.
Selection	getSelection(InPort inport) Returns the selection which targets the given inport.
protected SelectionModule	getSelectionModule() Gets the selection module.
SelectionList	getSelections() Gets the selections defined for this SPR.
String	getSPRInfoString() Gets the string containing the full SPR info.
String	getStackDescription() Gets SPR stack type description.
String	getStackTypeName() Gets SPR stack type name.
List<SunriseStopCondition>	getStopConditions() Gets all stop conditions.
String	getTypeName() Gets the SPR type.
<T extends Module> boolean	hasModule(Class<T> clazz) Determines if the SPR contains a module of the given type.
boolean	hasSameDataAs(Object obj)
boolean	hasStopConditions() Determines if this SPR has stop conditions.
boolean	isPortPublished(Port port) Gets a flag which indicates if the given port is published or not.
void	onFinished() Called when SPR is finished.
void	onSerialization() Tell the SPR that serialization takes place.
void	publishPort(Port port) Publishes the given port.
void	registerForReturnValues(OutPort port) Registers the given port as return value of this SPR.
void	registerForReturnValues(OutPort port, Object value) Registers the given port as return value of this SPR.
boolean	registerForReturnValuesIfUnregistered(OutPort port, Object value) Registers the given port as return value of this SPR.
void	removeAssignment(Assignment assignment) Removes the specified assignment from the SPR.
void	removeDefaultAssignment(DefaultAssignment defaultAssignment) Removes the specified DefaultAssignment from the SPR.
ActiveDevice	setActiveDevice(ActiveDevice activeDevice) Sets the active device for this SPR.
ActiveDevice	setActiveDevice(String deviceName, String mode) Sets the active device for this SPR.
void	setCanHandleSafetyStopRequest(boolean can) Sets "can handle safety request" flag.
void	setDescription(String description) Sets the SPR description.
void	setDeviceName(String deviceName) Sets the of the device with which this SPR associated.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_SPR_ID

public static final long INVALID_SPR_ID

SPR ID synonymous with "invalid SPR".

See Also:

Constant Field Values

Constructor Detail

SPR

public SPR(String typeName)

Creates a new instance with the given type name. The type name can be null (for the moment).

Parameters:

typeName - 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.

SPR

public SPR(String typeName,
           String deviceName)

Creates a new instance with the given type name for a device and on the default layer.

Parameters:

typeName - The type name of the SPR.

deviceName - name of the device for which this SPR is defined.

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.

SPR

public SPR(String typeName,
           int layer,
           String deviceName)

Creates a new instance of layered with the given type name and description.

Parameters:

typeName - The type name of the SPR. Can be null (for the moment).

deviceName - name of the device for which this SPR is defined.

layer - The layer id.

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

getRuntime

public SPRRuntime getRuntime()

Gets the runtime class associated with this SPR.

Returns:

the runtime class associated with this 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.

getFrameDefinitions

public final FrameDefinitionList getFrameDefinitions()

Gets the frame definitions of this SPR.

Returns:

The frame definitions of this 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.

getReturnValues

public final ReturnValues getReturnValues()

Gets all return values.

Returns:

All return values.

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.

getModules

public final Iterable<Module> getModules()

Gets all modules.

Returns:

All modules.

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.

getModule

public Module getModule(String name)

Gets the module of the given name.

Parameters:

name - The name of a module.

Returns:

The module with the given name if exists; otherwise null. The method expects that all module names are unique

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.

getModules

public final <T extends Module> Iterable<T> getModules(Class<T> clazz)

Gets the all modules of the specified type.

Type Parameters:

T - type of the module

Parameters:

clazz - type of the module to look for.

Returns:

all modules of the specified type, or empty if no module of desired class exists.

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.

getModule

public <T extends Module> T getModule(Class<T> clazz)

Gets the first module of the specified type.

Type Parameters:

T - type of the module

Parameters:

clazz - type of the module to look for.

Returns:

the first module of the specified type, or null if no modules of the type found.

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.

hasModule

public <T extends Module> boolean hasModule(Class<T> clazz)

Determines if the SPR contains a module of the given type.

Type Parameters:

T - type of the module

Parameters:

clazz - the module which the SPR is supposed to contain.

Returns:

True if the SPR contains the given module type, otherwise false.

getActiveDevice

public final ActiveDevice getActiveDevice()

Gets the active device for this SPR.

Returns:

The active device or null, if no device was set.

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.

getSelections

public final SelectionList getSelections()

Gets the selections defined for this SPR.

Returns:

the selections defined for this 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.

getDefaultAssignments

public final Iterable<DefaultAssignment> getDefaultAssignments()

Gets all default assignments.

Returns:

All default assignments.

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.

getAssignments

public final Iterable<Assignment> getAssignments()

Gets all assignments.

Returns:

All assignments.

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.

getAssignmentByInPort

public final Assignment getAssignmentByInPort(InPort inPort)

Gets the assignment with the specified input port.

Parameters:

inPort - the input port to search for.

Returns:

Assignment with the specified input port or null if not found.

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.

getAssignmentByInPort

public final Assignment getAssignmentByInPort(String componentInstanceName,
                                              String portName)

Gets the assignment with the specified input port.

Parameters:

componentInstanceName - the instance name of the component

portName - the port name

Returns:

Assignment with the specified input port or null if not found.

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.

getStopConditions

public final List<SunriseStopCondition> getStopConditions()

Gets all stop conditions.

Returns:

All stop conditions.

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.

hasStopConditions

public final boolean hasStopConditions()

Determines if this SPR has stop conditions.

Returns:

True if this SPR has stop conditions.

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.

setActiveDevice

public final ActiveDevice setActiveDevice(String deviceName,
                                          String mode)

Sets the active device for this SPR.

Parameters:

deviceName - The name of the device.

mode - The mode of the device.

Returns:

The created active device for parameterization.

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.

addSelectiveAssignment

public final SelectiveAssignment addSelectiveAssignment(int selectionLevel,
                                                        SPRComponent left,
                                                        String inportName,
                                                        SPRComponent right,
                                                        String outportName)

Adds an selective assignment to this SPR.

Parameters:

selectionLevel - The level of the selective assignment.

left - The compound containing the inport.

inportName - The name of the inport.

right - The compound containing the outport.

outportName - The name of the outport.

Returns:

The selection belonging to the selective assignment.

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.

addSelectiveAssignment

public final SelectiveAssignment addSelectiveAssignment(SelectiveAssignment assignment)

Adds an selective assignment to this SPR.

Parameters:

assignment - The selective assignment.

Returns:

The selection belonging to the selective assignment.

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.

addSelectiveAssignment

public final SelectiveAssignment addSelectiveAssignment(int selectionLevel,
                                                        InPort inport,
                                                        OutPort outport)

Adds an selective assignment to this SPR.

Parameters:

selectionLevel - The level of the selective assignment.

inport - The inport of the assignment.

outport - The outport of the assignment.

Returns:

The selection belonging to the selective assignment.

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.

getSelection

public final Selection getSelection(InPort inport)

Returns the selection which targets the given inport. Throws an exception if no selection can be found.

Parameters:

inport - The inport for which the selection should be returned.

Returns:

The selection which targets the given inport.

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.

addAssignment

public final Assignment addAssignment(SPRComponent destination,
                                      String inportName,
                                      SPRComponent source,
                                      String outportName)

Adds an assignment to this SPR. If this assignment already exists, the existing assignment will be used and returned from this method. We do this to avoid mutual assignments in Sunrise.
NOTE: Always use the returned reference for further operations.

Parameters:

destination - The compound containing the inport.

inportName - The name of the inport.

source - The compound containing the outport.

outportName - The name of the outport.

Returns:

The given assignment.

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.

addLooseAssignment

public final Assignment addLooseAssignment(SPRComponent destination,
                                           String inportName,
                                           SPRComponent source,
                                           String outportName)

Adds an intercyclic (loose) assignment to this SPR. This assignment will be delayed by one SPR cycle. If this assignment already exists, the existing assignment will be used and returned from this method. We do this to avoid mutual assignments in Sunrise.
NOTE: Always use the returned reference for further operations.

Parameters:

destination - The compound containing the inport.

inportName - The name of the inport.

source - The compound containing the outport.

outportName - The name of the outport.

Returns:

The given assignment.

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.

addAssignment

public final Assignment addAssignment(InPort inport,
                                      OutPort outport)

Adds an assignment to this SPR. If this assignment already exists, the existing assignment will be used and returned from this method. We do this to avoid mutual assignments in Sunrise.
NOTE: Always use the returned reference for further operations.

Parameters:

inport - The inport of the assignment.

outport - The outport of the assignment.

Returns:

The created assignment.

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.

addLooseAssignment

public final Assignment addLooseAssignment(InPort inport,
                                           OutPort outport)

Adds an intercyclic (loose) assignment to this SPR. This assignment will be delayed by one SPR cycle. If this assignment already exists, the existing assignment will be used and returned from this method. We do this to avoid mutual assignments in Sunrise.
NOTE: Always use the returned reference for further operations.

Parameters:

inport - The inport of the assignment.

outport - The outport of the assignment.

Returns:

The created assignment.

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.

addInterSprAssignment

public Assignment addInterSprAssignment(InPort inport,
                                        OutPort outport)

Adds assignment between ports belonging to compounds from different SPRs.

Parameters:

inport - The inport of the assignment.

outport - The outport of the assignment.

Returns:

Created assignment.

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.

addAssignment

public final DefaultAssignment addAssignment(SPRComponent destination,
                                             SPRComponent source)

Adds a new default assignment to this SPR connecting the leftInportsCompound (the compound with the inports) with the rightOutportsCompound (the compound with the outports).

Parameters:

destination - The compound whose inports will be connected.

source - The compound whose outports will be connected.

Returns:

The assignment itself.

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.

addLooseAssignment

public final DefaultAssignment addLooseAssignment(SPRComponent destination,
                                                  SPRComponent source)

Adds a new intercyclic (loose) default assignment to this SPR connecting the leftInportsCompound (the compound with the inports) with the rightOutportsCompound (the compound with the outports). This assignment will be delayed by one SPR cycle.

Parameters:

destination - The compound whose inports will be connected.

source - The compound whose outports will be connected.

Returns:

The assignment itself.

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.

registerForReturnValuesIfUnregistered

public final boolean registerForReturnValuesIfUnregistered(OutPort port,
                                                           Object value)

Registers the given port as return value of this SPR. Do not override already registered ports unintentionally

Parameters:

port - The port which should be registered. null is not allowed.

value - The value which should be assigned to the port and which will contain the return values. Please note that the value needs to be convertible to an ISerializableType.

Returns:

true, if port could be registered - false, if port was already registered

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.

registerForReturnValues

public final void registerForReturnValues(OutPort port,
                                          Object value)

Registers the given port as return value of this SPR.

Parameters:

port - The port which should be registered. null is not allowed.

value - The value which should be assigned to the port and which will contain the return values. Please note that the value needs to be convertible to an ISerializableType.

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.

registerForReturnValues

public void registerForReturnValues(OutPort port)

Registers the given port as return value of this SPR.

Note that the port needs to have a valid value (a value that can be converted to an ISerializableType). Otherwise, the method will fail.

Parameters:

port - The port which should be registered.

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.

addStopCondition

public SunriseStopCondition addStopCondition(String stopConditionExpression)

Adds a stop condition to this SPR.

Parameters:

stopConditionExpression - The stop condition expression.

E.g.: moduleInstanceName["OutportName"] > 0.99

Returns:

The created stop condition.

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.

addStopCondition

public SunriseStopCondition addStopCondition(SunriseStopCondition stopCondition)

Adds a stop condition to this SPR.

Parameters:

stopCondition - The stop condition.

Returns:

The stop condition.

setActiveDevice

public ActiveDevice setActiveDevice(ActiveDevice activeDevice)

Sets the active device for this SPR.

Parameters:

activeDevice - The active device.

Returns:

The active device.

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.

addModule

public void addModule(Module module)

Adds a compound to this SPR.

Parameters:

module - The module to add.

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.

addAssignment

public DefaultAssignment addAssignment(DefaultAssignment assignment)

Adds the default assignment to this SPR.

Parameters:

assignment - The default assignment. May no be null.

Returns:

The assignment itself.

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.

removeDefaultAssignment

public void removeDefaultAssignment(DefaultAssignment defaultAssignment)

Removes the specified DefaultAssignment from the SPR.

Parameters:

defaultAssignment - DefaultAssignment to remove.

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.

addAssignment

public Assignment addAssignment(Assignment assignment)

Adds an assignment to this SPR. If this assignment already exists, the existing assignment will be used and returned from this method. We do this to avoid mutual assignments in Sunrise.
NOTE: Always use the returned reference for further operations.

Parameters:

assignment - The assignment to add.

Returns:

The given assignment.

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.

removeAssignment

public void removeAssignment(Assignment assignment)

Removes the specified assignment from the SPR.

Parameters:

assignment - Assignment to remove.

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.

onSerialization

public void onSerialization()

Tell the SPR that serialization takes place. Every module will get informed.

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.

onFinished

public void onFinished()

Called when SPR is finished.

Used to release resources sued by the compounds of the SPR. Calls onFinished methods of all compounds.

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.

getSPRInfoString

public String getSPRInfoString()

Gets the string containing the full SPR info.

Returns:

the string containing the full SPR info.

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.

toString

public String toString()

Overrides:

toString in class Object

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.

getSelectionModule

protected SelectionModule getSelectionModule()

Gets the selection module.

Returns:

The selection module.

getTypeName

public String getTypeName()

Gets the SPR type.

Returns:

the type 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.

getDescription

public String getDescription()

Gets the SPR description.

Returns:

the SPR description

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.

setDescription

public void setDescription(String description)

Sets the SPR description.

Parameters:

description - the description to set

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.

getLayerAttachment

public int getLayerAttachment()

Gets the layer attachment.

Returns:

The layer attachment.

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.

hasSameDataAs

public boolean hasSameDataAs(Object obj)

Specified by:

hasSameDataAs in interface com.kuka.common.IDataEquatable

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.

getExpressionSegmentString

public String getExpressionSegmentString(String tag)

Gets the runtime value of an expression segment.

Specified by:

getExpressionSegmentString in interface IExpressionSegment

Parameters:

tag - An identifier which specifies the requested value.

Returns:

The runtime value of the given tag.

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.

publishPort

public void publishPort(Port port)

Publishes the given port. Published ports can be used for communication between SPRs.

Parameters:

port - The port to be published.

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.

isPortPublished

public boolean isPortPublished(Port port)

Gets a flag which indicates if the given port is published or not.

Parameters:

port - The port of which the caller wants to know if it is published.

Returns:

True if the given port is published; otherwise false.

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.

getPublishedPorts

public Map<String,Port> getPublishedPorts()

Gets a list of all published ports of this SPR.

Returns:

the published ports

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.

canHandleSafetyStopRequest

public boolean canHandleSafetyStopRequest()

Returns true if this SPR can handle safety StopRequest and will not be automatically cancelled by Sunrise when a StopRequest is signaled.

Returns:

true if this SPR can handle StopRequest and will not be automatically cancelled by Sunrise when a StopRequest is signaled.

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.

setCanHandleSafetyStopRequest

public void setCanHandleSafetyStopRequest(boolean can)

Sets "can handle safety request" flag.

Parameters:

can - true if the SPR can handle safety requests.

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.

getDeviceName

public String getDeviceName()

Gets the name of the device with which this SPR associated.

If SPR contains an ActiveDevice - the name of it will be returned, otherwise - returned value set by setDeviceName(String) method.

Returns:

the name of the device with which this SPR associated. Can be null.

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.

setDeviceName

public void setDeviceName(String deviceName)

Sets the of the device with which this SPR associated.

SPRs which contain an ActiveDevice (pipe SPRs) do not need it. The name should be set for layer SPRs without a pipe.

Parameters:

deviceName - name of the associated device.

Throws:

IllegalStateException - if the SPR contains an ActiveDevice

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.

getStackTypeName

public String getStackTypeName()

Gets SPR stack type name.

Returns:

stackTypeName Stack type 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.

getStackDescription

public String getStackDescription()

Gets SPR stack type description.

Returns:

stackDescription Stack Description

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.

getGlobalDataServiceModule

public GlobalDataServiceModule getGlobalDataServiceModule()

Gets instance of GlobalDataServiceModule used for this SPR.

Returns:

instance of GlobalDataServiceModule used for this 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.