msim.model

Enum Joint.ResidualType

java.lang.Object

java.lang.Enum<Joint.ResidualType>

msim.model.Joint.ResidualType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Joint.ResidualType>

Enclosing class:

Joint

public static enum Joint.ResidualType
extends java.lang.Enum<Joint.ResidualType>

Residual type requested for Joint.getResidual(int, ResidualType, int, double[]).

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL_DOF_OR_DOI_RESIDUAL Get a residual for all DoF or DoI of the current Joint.Type, as appliccable.
FULL_RESIDUAL get a full 6-component residual
PARTIAL_RESIDUAL For Joint.RX_TARGET or Joint.RX_POSTURE, only get a residual for the currently set goal components, if any.

Method Summary

Methods

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

FULL_RESIDUAL

public static final Joint.ResidualType FULL_RESIDUAL

get a full 6-component residual

FULL_DOF_OR_DOI_RESIDUAL

public static final Joint.ResidualType FULL_DOF_OR_DOI_RESIDUAL

Get a residual for all DoF or DoI of the current Joint.Type, as appliccable.

PARTIAL_RESIDUAL

public static final Joint.ResidualType PARTIAL_RESIDUAL

For Joint.RX_TARGET or Joint.RX_POSTURE, only get a residual for the currently set goal components, if any.

Same behavior as FULL_DOF_OR_DOI_RESIDUAL otherwise.

Method Detail

values

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

Returns:

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

valueOf

public static Joint.ResidualType 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