Package frc.robot.util

Record Class Aiming.AimingResult

java.lang.Object
java.lang.Record
frc.robot.util.Aiming.AimingResult
Enclosing class:
Aiming
public static record Aiming.AimingResult(Rotation2d targetRotation, double distanceToTargetMeters, boolean hasTarget) extends Record
Cached result of the aiming pipeline, including target rotation, distance, and target presence.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AimingResult(Rotation2d targetRotation, double distanceToTargetMeters, boolean hasTarget)
    Creates an instance of a AimingResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distanceToTargetMeters()
    Returns the value of the distanceToTargetMeters 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.
    boolean
    hasTarget()
    Returns the value of the hasTarget record component.
    Rotation2d
    targetRotation()
    Returns the value of the targetRotation 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

    • AimingResult

      public AimingResult(Rotation2d targetRotation, double distanceToTargetMeters, boolean hasTarget)
      Creates an instance of a AimingResult record class.
      Parameters:
      targetRotation - the value for the targetRotation record component
      distanceToTargetMeters - the value for the distanceToTargetMeters record component
      hasTarget - the value for the hasTarget 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • targetRotation

      public Rotation2d targetRotation()
      Returns the value of the targetRotation record component.
      Returns:
      the value of the targetRotation record component

    • distanceToTargetMeters

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

    • hasTarget

      public boolean hasTarget()
      Returns the value of the hasTarget record component.
      Returns:
      the value of the hasTarget record component