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

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.Assignment
      com.kuka.roboticsAPI.controllerModel.sunrise.api.SelectiveAssignment

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISegment

public class SelectiveAssignment
extends Assignment

Multiple selective assignments can target a single inport. Using a level, one can specify what happens, if a port has invalid 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.

Constructor Summary

SelectiveAssignment(int selectionLevel, InPort inport, OutPort outport)
Creates a new selective assignment.

SelectiveAssignment(int level, SPRComponent inportCompound, String inportName, SPRComponent outportCompound, String outportName)
Creates a new selective assignment.

Method Summary

<T> Parameter<T>	addParameter(String name, T value) Adds a new parameter to this compound.
Parameter<?>	getParameter(String name) Gets the parameter with the specified name.
ParameterList	getParameterList() Gets the parameter list of this compound.
Selection	getSelection() Gets the selection in which the assignment participates.
int	getSelectionLevel() Gets the level of this selective assignment.
boolean	hasSameDataAs(Object obj)
void	setSelectionLevel(int selectionLevel) Sets the level of this selective assignment.
String	toString()

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

getChecksum, getComponentType, getComponentVersion, getInPort, getOutPort, isLoose, setInPort, setOutPort

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectiveAssignment

public SelectiveAssignment(int level,
                           SPRComponent inportCompound,
                           String inportName,
                           SPRComponent outportCompound,
                           String outportName)

Creates a new selective assignment.

Parameters:

level - The level of the assignment.

inportCompound - The compound containing the inport.

inportName - The name of the inport.

outportCompound - The compoudn containing the outport.

outportName - The name of the outport.

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.

SelectiveAssignment

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

Creates a new selective assignment.

Parameters:

selectionLevel - The level of the assignment.

inport - The inport of the assignment.

outport - The outport of the 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.

Method Detail

setSelectionLevel

public void setSelectionLevel(int selectionLevel)

Sets the level of this selective assignment.

Parameters:

selectionLevel - The level of this 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.

getSelectionLevel

public int getSelectionLevel()

Gets the level of this selective assignment.

Returns:

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

addParameter

public final <T> Parameter<T> addParameter(String name,
                                           T value)

Adds a new parameter to this compound. This method does not care if the same parameter is added twice. If a parameter with the same name was already added, this parameter will be replaced by the new one.

Type Parameters:

T - The type of the parameter.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

Returns:

The created parameter.

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.

getParameterList

public ParameterList getParameterList()

Gets the parameter list of this compound.

Returns:

The parameter list of this compound.

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.

getParameter

public final Parameter<?> getParameter(String name)

Gets the parameter with the specified name.

Parameters:

name - The name of the parameter. null is not allowed.

Returns:

The parameter with the specified 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.

toString

public String toString()

Overrides:

toString in class 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 Selection getSelection()

Gets the selection in which the assignment participates.

The selection is set when the assignment was added to an SPR. Until then, the method returns null.

Returns:

The selection.

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

Overrides:

hasSameDataAs in class 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.