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

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.FrameSetting
      com.kuka.roboticsAPI.controllerModel.sunrise.api.DynamicFrameSetting

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISegment

public class DynamicFrameSetting
extends FrameSetting

A dynamic frame setting is used to describe a geometric relation between two frames through a dynamic value that comes from a DFE element.

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

DynamicFrameSetting(String referenceName, OutPort outport, String targetName)
Creates a new DynamicFrameSetting instance.

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.
OutPort	getOutPort() Gets the outport assigned to this dynamic frame setting.
boolean	hasSameDataAs(Object obj)
void	setOutPort(OutPort port) Sets the outport assigned to this dynamic frame setting.

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

getReferenceName, getTargetName

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicFrameSetting

public DynamicFrameSetting(String referenceName,
                           OutPort outport,
                           String targetName)

Creates a new DynamicFrameSetting instance.

Parameters:

referenceName - The name of the reference frame.

outport - The DFE element offering the data.

targetName - The name of the target frame.

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

getOutPort

public final OutPort getOutPort()

Gets the outport assigned to this dynamic frame setting.

Returns:

The outport assigned to this dynamic frame setting.

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 final void setOutPort(OutPort port)

Sets the outport assigned to this dynamic frame setting.

Parameters:

port - The new outport assigned to this dynamic frame setting.

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.

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.

getComponentType

public String getComponentType()

Gets the type of this component.

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.

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.

hasSameDataAs

public boolean hasSameDataAs(Object obj)

Specified by:

hasSameDataAs in interface com.kuka.common.IDataEquatable

Overrides:

hasSameDataAs in class FrameSetting

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.