Package xbot.common.controls.actuators

Record Class XCANMotorControllerPIDProperties

java.lang.Object
java.lang.Record
xbot.common.controls.actuators.XCANMotorControllerPIDProperties
public record XCANMotorControllerPIDProperties(double p, double i, double d, double velocityFeedForward, double gravityFeedForward, double maxOutput, double minOutput) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    XCANMotorControllerPIDProperties()
     
    XCANMotorControllerPIDProperties(double p, double i, double d)
     
    XCANMotorControllerPIDProperties(double p, double i, double d, double velocityFeedForward, double gravityFeedForward, double maxOutput, double minOutput)
    Creates an instance of a XCANMotorControllerPIDProperties record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    d()
    Returns the value of the d record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    gravityFeedForward()
    Returns the value of the gravityFeedForward record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    i()
    Returns the value of the i record component.
    double
    maxOutput()
    Returns the value of the maxOutput record component.
    double
    minOutput()
    Returns the value of the minOutput record component.
    double
    p()
    Returns the value of the p record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    velocityFeedForward()
    Returns the value of the velocityFeedForward record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • XCANMotorControllerPIDProperties

      public XCANMotorControllerPIDProperties()

    • XCANMotorControllerPIDProperties

      public XCANMotorControllerPIDProperties(double p, double i, double d)

    • XCANMotorControllerPIDProperties

      public XCANMotorControllerPIDProperties(double p, double i, double d, double velocityFeedForward, double gravityFeedForward, double maxOutput, double minOutput)
      Creates an instance of a XCANMotorControllerPIDProperties record class.
      Parameters:
      p - the value for the p record component
      i - the value for the i record component
      d - the value for the d record component
      velocityFeedForward - the value for the velocityFeedForward record component
      gravityFeedForward - the value for the gravityFeedForward record component
      maxOutput - the value for the maxOutput record component
      minOutput - the value for the minOutput record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • p

      public double p()
      Returns the value of the p record component.
      Returns:
      the value of the p record component

    • i

      public double i()
      Returns the value of the i record component.
      Returns:
      the value of the i record component

    • d

      public double d()
      Returns the value of the d record component.
      Returns:
      the value of the d record component

    • velocityFeedForward

      public double velocityFeedForward()
      Returns the value of the velocityFeedForward record component.
      Returns:
      the value of the velocityFeedForward record component

    • gravityFeedForward

      public double gravityFeedForward()
      Returns the value of the gravityFeedForward record component.
      Returns:
      the value of the gravityFeedForward record component

    • maxOutput

      public double maxOutput()
      Returns the value of the maxOutput record component.
      Returns:
      the value of the maxOutput record component

    • minOutput

      public double minOutput()
      Returns the value of the minOutput record component.
      Returns:
      the value of the minOutput record component