artisynth.core.mechmodels

Enum ExcitationComponent.CombinationRule

java.lang.Object

java.lang.Enum<ExcitationComponent.CombinationRule>

artisynth.core.mechmodels.ExcitationComponent.CombinationRule

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExcitationComponent.CombinationRule>

Enclosing interface:

ExcitationComponent

public static enum ExcitationComponent.CombinationRule
extends java.lang.Enum<ExcitationComponent.CombinationRule>

Combination rules for excitations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Sum Indicates that excitations should be combined by direct summation.

Method Summary

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

Sum

public static final ExcitationComponent.CombinationRule Sum

Indicates that excitations should be combined by direct summation.

Method Detail

values

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

Returns:

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

valueOf

public static ExcitationComponent.CombinationRule 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