Package edu.tufts.hrilab.teleop

Record Class TeleopGui.Twist

java.lang.Object
java.lang.Record
edu.tufts.hrilab.teleop.TeleopGui.Twist
Enclosing class:
TeleopGui
public static record TeleopGui.Twist(double linearXMps, double linearYMps, double angularRadps) extends Record
Simple velocity container (holonomic): x forward, y left, yaw CCW.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Twist(double linearXMps, double linearYMps, double angularRadps)
    Creates an instance of a Twist record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Twist

      public Twist(double linearXMps, double linearYMps, double angularRadps)
      Creates an instance of a Twist record class.
      Parameters:
      linearXMps - the value for the linearXMps record component
      linearYMps - the value for the linearYMps record component
      angularRadps - the value for the angularRadps 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.

    • linearXMps

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

    • linearYMps

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

    • angularRadps

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