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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISegment

Direct Known Subclasses:

DynamicFrameSetting, StaticFrameSetting

public abstract class FrameSetting
extends Object
implements ISegment

Base class for frame settings. A frame setting must at least have a reference and target 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.

Constructor Summary

protected

FrameSetting(String referenceName, String targetName) Creates a new frame setting.

Method Summary

String	getReferenceName() Gets the reference name of this frame setting.
String	getTargetName() Gets the target name of this frame setting.
boolean	hasSameDataAs(Object obj)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.ISegment

getChecksum, getComponentType, getComponentVersion

Constructor Detail

FrameSetting

protected FrameSetting(String referenceName,
                       String targetName)

Creates a new frame setting.

Parameters:

referenceName - The name of the reference frame.

targetName - The name of the target frame.

Method Detail

getReferenceName

public String getReferenceName()

Gets the reference name of this frame setting.

Returns:

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

getTargetName

public String getTargetName()

Gets the target name of this frame setting.

Returns:

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

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.