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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISegment

Direct Known Subclasses:

SelectiveAssignment

public class Assignment
extends Object
implements ISegment

An assignment connects a inport and a outport in a 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.

Constructor Summary

Assignment(InPort inport, OutPort outport)
Creates a new assignment, implicitly creating a strict assignment, contrary to a loose assignment.

Assignment(InPort inport, OutPort outport, boolean isloose)
Creates a new assignment, explicitly stating looseness.

Assignment(SPRComponent inportCompound, String inportName, SPRComponent outportCompound, String outportName)
Creates a new assignment, implicitly creating a strict assignment, contrary to a loose assignment.

Assignment(SPRComponent inportCompound, String inportName, SPRComponent outportCompound, String outportName, boolean isLoose)
Creates a new assignment, explicitly stating looseness.

Method Summary

int	getChecksum() Returns the checksum for the segment.
String	getComponentType() Gets the type of this component.
String	getComponentVersion() Gets the version of this component.
InPort	getInPort() Gets the inport of the assignment.
OutPort	getOutPort() Gets the outport of the assignment.
boolean	hasSameDataAs(Object obj)
boolean	isLoose() Returns whether this assignment is loose (true) or not.
void	setInPort(InPort port) Sets the given port as new inport.
void	setOutPort(OutPort port) Sets the given port as new outport.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Assignment

public Assignment(InPort inport,
                  OutPort outport)

Creates a new assignment, implicitly creating a strict assignment, contrary to a loose assignment.

Parameters:

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.

Assignment

public Assignment(InPort inport,
                  OutPort outport,
                  boolean isloose)

Creates a new assignment, explicitly stating looseness.

Parameters:

inport - The inport of the assignment.

outport - The outport of the assignment.

isloose - Flag to determine if the assignment should be delayed to the next SPR cycle. True: delay the assignment, false: otherwise.

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.

Assignment

public Assignment(SPRComponent inportCompound,
                  String inportName,
                  SPRComponent outportCompound,
                  String outportName)

Creates a new assignment, implicitly creating a strict assignment, contrary to a loose assignment.

Parameters:

inportCompound - The compound containing the inport.

inportName - The name of the inport.

outportCompound - The compound 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.

Assignment

public Assignment(SPRComponent inportCompound,
                  String inportName,
                  SPRComponent outportCompound,
                  String outportName,
                  boolean isLoose)

Creates a new assignment, explicitly stating looseness.

Parameters:

inportCompound - The compound containing the inport.

inportName - The name of the inport.

outportCompound - The compound containing the outport.

outportName - The name of the outport.

isLoose - Flag to determine if the assignment should be delayed to the next SPR cycle. True: delay the assignment, false: otherwise.

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

getInPort

public InPort getInPort()

Gets the inport of the assignment.

Returns:

The inport 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.

setInPort

public void setInPort(InPort port)

Sets the given port as new inport.

Parameters:

port - The new 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.

getOutPort

public OutPort getOutPort()

Gets the outport of the assignment.

Returns:

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.

setOutPort

public void setOutPort(OutPort port)

Sets the given port as new outport.

Parameters:

port - The new 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.

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.

getComponentType

public String getComponentType()

Gets the type of this component.

Specified by:

getComponentType in interface ISegment

Returns:

The type of this component.

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.

getComponentVersion

public String getComponentVersion()

Gets the version of this component.

Specified by:

getComponentVersion in interface ISegment

Returns:

The version of this component.

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.

getChecksum

public int getChecksum()

Returns the checksum for the segment.

Specified by:

getChecksum in interface ISegment

Returns:

The checksum for the segment.

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.

isLoose

public boolean isLoose()

Returns whether this assignment is loose (true) or not. Loose means that the assignment will be delayed by one SPR cycle, and it will not be considered when checking for cycles in the assignment graph.

Returns:

True if the assignment loose, false otherwise.