com.kuka.roboticsAPI.controllerModel.sunrise.api
Enum PredefinedFrames

java.lang.Object
  java.lang.Enum<PredefinedFrames>
      com.kuka.roboticsAPI.controllerModel.sunrise.api.PredefinedFrames

All Implemented Interfaces:

Serializable, Comparable<PredefinedFrames>

public enum PredefinedFrames
extends Enum<PredefinedFrames>

Describes predefined frame names.

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.

Enum Constant Summary

AlignmentFrame
Alignment frame.

AlignmentFrame_CmdT1m
Alignment frame cmd.

AlignmentFrame_Msr
Alignment frame msr.

AuxiliaryFrame
AuxiliaryFrame.

ControlActionFrame
Control action frame.

RobotBaseFrame
Robot base frame.

RobotFlangeFrame
Robot flange frame.

RobotFlangeFrame_CmdT1m
Robot flange frame cmdT1m.

RobotFlangeFrame_Msr
Robot flange frame msr.

TaskFrame
Task frame.

TaskFrame_Msr
Task frame msr.

WorldFrame
World frame.

Method Summary

String	getName() Gets the name of the predefined frame.
static PredefinedFrames	valueOf(String name) Returns the enum constant of this type with the specified name.
static PredefinedFrames[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TaskFrame

public static final PredefinedFrames TaskFrame

Task frame.

TaskFrame_Msr

public static final PredefinedFrames TaskFrame_Msr

Task frame msr.

AlignmentFrame

public static final PredefinedFrames AlignmentFrame

Alignment frame.

AlignmentFrame_Msr

public static final PredefinedFrames AlignmentFrame_Msr

Alignment frame msr.

AlignmentFrame_CmdT1m

public static final PredefinedFrames AlignmentFrame_CmdT1m

Alignment frame cmd.

ControlActionFrame

public static final PredefinedFrames ControlActionFrame

Control action frame.

RobotBaseFrame

public static final PredefinedFrames RobotBaseFrame

Robot base frame.

RobotFlangeFrame

public static final PredefinedFrames RobotFlangeFrame

Robot flange frame.

RobotFlangeFrame_Msr

public static final PredefinedFrames RobotFlangeFrame_Msr

Robot flange frame msr.

RobotFlangeFrame_CmdT1m

public static final PredefinedFrames RobotFlangeFrame_CmdT1m

Robot flange frame cmdT1m.

AuxiliaryFrame

public static final PredefinedFrames AuxiliaryFrame

AuxiliaryFrame.

WorldFrame

public static final PredefinedFrames WorldFrame

World frame.

Method Detail

values

public static PredefinedFrames[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PredefinedFrames c : PredefinedFrames.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PredefinedFrames valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Gets the name of the predefined frame.

Returns:

The name of the predefined 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.