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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment

Direct Known Subclasses:

InPort, OutPort

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

A port is a Data-Flow-Element (DFE) in a SPR. Ports belong to parents and can be connected with 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.

Constructor Summary

Port(String name)
Creates a new port with the given name.

Method Summary

String	getExpressionSegmentString(String tag) Gets the runtime value of an expression segment.
String	getFullName() Gets a full name of the port 'parent_name.port_name'.
String	getName() Gets the name of the port.
protected ISerializableType	getSerializableType(Object value) Gets the serializable type of the port.
SPRComponent	getSPRComponent() Gets the parent to which this port belongs.
protected ISerializableType	getWrappedValue() Gets the wrapped serializable value of the port.
boolean	hasSameDataAs(Object obj)
boolean	hasValue() Returns true if the value of the port is not null.
protected void	setInternalValue(Object value) Sets the port value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Port

public Port(String name)

Creates a new port with the given name.

Parameters:

name - The name of the port. Must be unique in it's parent.

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

getName

public String getName()

Gets the name of the port.

Returns:

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.

hasValue

public boolean hasValue()

Returns true if the value of the port is not null.

Returns:

true if the value of the port is not null.

getSPRComponent

public SPRComponent getSPRComponent()

Gets the parent to which this port belongs.

Returns:

The parent to which this port belongs.

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.

getFullName

public String getFullName()

Gets a full name of the port 'parent_name.port_name'.

Returns:

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

getSerializableType

protected ISerializableType getSerializableType(Object value)

Gets the serializable type of the port. If the port has no value or an incompatible value, this method will fail.

Parameters:

value - The value to wrap. Has to be convertible to an ISerializableType.

Returns:

The serializable type of the port.

setInternalValue

protected void setInternalValue(Object value)

Sets the port value. Will fail if the value is != null and not compatible.

Parameters:

value - The new value. Can be null. But if the value is not null, it has to be convertible to an ISerializableType.

getWrappedValue

protected ISerializableType getWrappedValue()

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

Returns:

The wrapped value.

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.