com.aldebaran.qi.sdk.object.autonomousabilities

Enum DegreeOfFreedom

java.lang.Object

java.lang.Enum<DegreeOfFreedom>

com.aldebaran.qi.sdk.object.autonomousabilities.DegreeOfFreedom

All Implemented Interfaces:

QiEnum, java.io.Serializable, java.lang.Comparable<DegreeOfFreedom>

public enum DegreeOfFreedom
extends java.lang.Enum<DegreeOfFreedom>
implements QiEnum

A degree of freedom.

Since:

6

Enum Constant Summary

Enum Constants

Enum Constant and Description
ROBOT_FRAME_ROTATION Robot frame rotation degree of freedom with regards to a world-fixed frame.
UNSUPPORTED_VALUE This value might be retrieved when the enum has evolved and the client application is not using the corresponding version.

Method Summary

Modifier and Type	Method and Description
int	getQiValue()
static DegreeOfFreedom	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DegreeOfFreedom[]	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

UNSUPPORTED_VALUE

public static final DegreeOfFreedom UNSUPPORTED_VALUE

This value might be retrieved when the enum has evolved and the client application is not using the corresponding version.

ROBOT_FRAME_ROTATION

public static final DegreeOfFreedom ROBOT_FRAME_ROTATION

Robot frame rotation degree of freedom with regards to a world-fixed frame.

Since:

6

Method Detail

values

public static DegreeOfFreedom[] 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 (DegreeOfFreedom c : DegreeOfFreedom.values())
    System.out.println(c);

Returns:

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

valueOf

public static DegreeOfFreedom valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getQiValue

public int getQiValue()

Specified by:

getQiValue in interface QiEnum