Package frc.team4373.swerve

Enum SwerveDrivetrain.BrakeMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SwerveDrivetrain.BrakeMode>
    Enclosing class:
    SwerveDrivetrain
    public static enum SwerveDrivetrain.BrakeMode
extends java.lang.Enum<SwerveDrivetrain.BrakeMode>
    The swerve brake mode for the swerve bot (i.e., what to do when the input is zero).

    The modes are as follows:

    • Implode mode points all wheels inward (toward the center of the bot)
    • Octagon mode points all wheels orthogonally to the diagonal that runs from the wheel to the center (the standard turning configuration)
    • When swerve brake mode is disabled, the wheels remain in the direction they were facing before stopping

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      IMPLODE  
      NONE  
      OCTAGON  

    • Method Summary

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

    • Method Detail

      • values

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

      • valueOf

        public static SwerveDrivetrain.BrakeMode 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