artisynth.core.inverse

Enum FrameExciter.WrenchDof

java.lang.Object

java.lang.Enum<FrameExciter.WrenchDof>

artisynth.core.inverse.FrameExciter.WrenchDof

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FrameExciter.WrenchDof>

Enclosing class:

FrameExciter

public static enum FrameExciter.WrenchDof
extends java.lang.Enum<FrameExciter.WrenchDof>

Specifies the degree-of-freedom along (or about) which the force (or moment) of this exciter will be applied to the frame.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FX Force along x (in world coordinates)
FY Force along y (in world coordinates)
FZ Force along z (in world coordinates)
MX Moment about x (in world coordinates)
MY Moment about y (in world coordinates)
MZ Moment about z (in world coordinates)

Method Summary

Modifier and Type	Method and Description
static FrameExciter.WrenchDof	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FrameExciter.WrenchDof[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FX

public static final FrameExciter.WrenchDof FX

Force along x (in world coordinates)

FY

public static final FrameExciter.WrenchDof FY

Force along y (in world coordinates)

FZ

public static final FrameExciter.WrenchDof FZ

Force along z (in world coordinates)

MX

public static final FrameExciter.WrenchDof MX

Moment about x (in world coordinates)

MY

public static final FrameExciter.WrenchDof MY

Moment about y (in world coordinates)

MZ

public static final FrameExciter.WrenchDof MZ

Moment about z (in world coordinates)

Method Detail

values

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

Returns:

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

valueOf

public static FrameExciter.WrenchDof 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