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

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

All Implemented Interfaces:

com.kuka.common.IDataEquatable, ISegment

public class StaticFrameSetting
extends FrameSetting

A static frame setting is used to describe a geometric relation between two frames through a static value that comes from a transformation matrix.

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

StaticFrameSetting(String referenceName, ITransformation transformation, 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.
ITransformation	getTransformation() Gets the transformation matrix of this static frame settings.
String	getTransformationName() Gets the optional frame name for the static setting.
boolean	hasSameDataAs(Object obj)
void	setTransformationName(String transformationName) Sets an optional frame name for the static 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

StaticFrameSetting

public StaticFrameSetting(String referenceName,
                          ITransformation transformation,
                          String targetName)

Creates a new DynamicFrameSetting instance.

Parameters:

referenceName - The name of the reference frame.

transformation - The transformation for the setting 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

getTransformation

public final ITransformation getTransformation()

Gets the transformation matrix of this static frame settings.

Returns:

The transformation matrix of this static frame settings.

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.

setTransformationName

public void setTransformationName(String transformationName)

Sets an optional frame name for the static setting. Used by serialization.

Parameters:

transformationName - The name for the transformation.

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.

getTransformationName

public String getTransformationName()

Gets the optional frame name for the static setting.

Returns:

The optional frame name for the static 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.