Class PID.PIDConstants

  • Enclosing class:
    PID

    public static class PID.PIDConstants
    extends java.lang.Object
    Data class for holding the gains to a PID controller.
    • Constructor Summary

      Constructors 
      Constructor Description
      PIDConstants​(double kP, double kI, double kD)
      Constructs a PIDConstants out of provided gains.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      double getkD()
      Returns the derivative gain.
      double getkI()
      Returns the integral gain.
      double getkP()
      Returns the proportional gain.
      int hashCode()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PIDConstants

        public PIDConstants​(double kP,
                            double kI,
                            double kD)
        Constructs a PIDConstants out of provided gains.
        Parameters:
        kP - The proportional gain.
        kI - The integral gain.
        kD - The derivative gain.
    • Method Detail

      • getkP

        public double getkP()
        Returns the proportional gain.
        Returns:
        The kP of the constants.
      • getkI

        public double getkI()
        Returns the integral gain.
        Returns:
        The kI of the constants.
      • getkD

        public double getkD()
        Returns the derivative gain.
        Returns:
        The kD of the constants.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object