Package frc.alotobots.library.subsystems.vision.photonvision.objectdetection.util

Record Class GameElement

java.lang.Object
java.lang.Record
frc.alotobots.library.subsystems.vision.photonvision.objectdetection.util.GameElement
Record Components:
name - The name of the object
length - The length of the object
width - The width of the object
height - The height of the object (floor to middle)
public record GameElement(String name, double length, double width, double height) extends Record
Represents a game element (measurements are in meters)

  • Constructor Summary

    Constructors
    Constructor
    Description
    GameElement(String name, double length, double width, double height)
    Creates an instance of a GameElement record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    height()
    Returns the value of the height record component.
    double
    length()
    Returns the value of the length record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    width()
    Returns the value of the width record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GameElement

      public GameElement(String name, double length, double width, double height)
      Creates an instance of a GameElement record class.
      Parameters:
      name - the value for the name record component
      length - the value for the length record component
      width - the value for the width record component
      height - the value for the height 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • length

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

    • width

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

    • height

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