Module org.dyn4j

Enum LimitState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LimitState>

    public enum LimitState
    extends java.lang.Enum<LimitState>
    Enumeration for the limit states a joint can have.
    Since:
    1.0.0
    Version:
    1.0.3
    Author:
    William Bittle
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AT_LOWER
      The state if the joint has reached or passed the lower limit
      AT_UPPER
      The state if the joint has reached or passed the upper limit
      EQUAL
      The state if the upper and lower limits are equal within tolerance
      INACTIVE
      The state if the joint limits are disabled or if the joint is between the limits
    • Method Summary

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

      • EQUAL

        public static final LimitState EQUAL
        The state if the upper and lower limits are equal within tolerance
      • AT_LOWER

        public static final LimitState AT_LOWER
        The state if the joint has reached or passed the lower limit
      • AT_UPPER

        public static final LimitState AT_UPPER
        The state if the joint has reached or passed the upper limit
      • INACTIVE

        public static final LimitState INACTIVE
        The state if the joint limits are disabled or if the joint is between the limits
    • Method Detail

      • values

        public static LimitState[] 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 (LimitState c : LimitState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static LimitState 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