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

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.Port
      com.kuka.roboticsAPI.controllerModel.sunrise.api.OutPort

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment

public class OutPort
extends Port

A outport is a port of a compound which provides result data of the compound in the data-flow.

Outports can be registered for returned values and therefore have values. If an outport is registered for return values its value will be automatically filled from Sunrise by every state change 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.

Constructor Summary

OutPort(String name)
Creates a new outport with the given name.

OutPort(String name, Object value)
Creates a new outport with the given name and the given value.

Method Summary

int	getUniqueId() Gets the unique id for this port for the return values.
Object	getValue() Gets the value of this port.
ISerializableType	getWrappedValue() Gets the wrapped serializable value of the port.
void	setValue(Object value) Sets the value for this port.
String	toString()

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

getExpressionSegmentString, getFullName, getName, getSerializableType, getSPRComponent, hasSameDataAs, hasValue, setInternalValue

Methods inherited from class java.lang.Object

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

Constructor Detail

OutPort

public OutPort(String name,
               Object value)

Creates a new outport with the given name and the given value.

Parameters:

name - The name of the port.

value - The value of the port.

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.

OutPort

public OutPort(String name)

Creates a new outport with the given name.

Parameters:

name - The name of the port.

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

getUniqueId

public int getUniqueId()

Gets the unique id for this port for the return values.

Returns:

The unique id of this port.

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.

getWrappedValue

public ISerializableType getWrappedValue()

Gets the wrapped serializable value of the port. If no value or an invalid value is set, this method will fail.

Overrides:

getWrappedValue in class Port

Returns:

The wrapped value.

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.

getValue

public Object getValue()

Gets the value of this port.

Returns:

The value of this port.

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.

setValue

public final void setValue(Object value)

Sets the value for this port.

Parameters:

value - The value for this port.

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.