Package megamek.client.bot.princess

Record Class AerospaceGeometry.AltitudeBand

java.lang.Object
java.lang.Record
megamek.client.bot.princess.AerospaceGeometry.AltitudeBand
Record Components:
lowest - the lowest altitude in the band
highest - the highest altitude in the band
Enclosing class:
AerospaceGeometry
public static record AerospaceGeometry.AltitudeBand(int lowest, int highest) extends Record
An inclusive range of altitudes.

A transient value passed between bot calculations; it is never written to a save file, so it needs no SerializationHelper converter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AltitudeBand(int lowest, int highest)
    Creates an instance of a AltitudeBand record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(int altitude)
     
    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.
    int
    highest()
    Returns the value of the highest record component.
    int
    lowest()
    Returns the value of the lowest record component.
    int
    midpoint()
    The altitude in this band a unit is likeliest to be found at, used when nothing better is known.
    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

    • AltitudeBand

      public AltitudeBand(int lowest, int highest)
      Creates an instance of a AltitudeBand record class.
      Parameters:
      lowest - the value for the lowest record component
      highest - the value for the highest record component

  • Method Details

    • contains

      public boolean contains(int altitude)
      Parameters:
      altitude - the altitude to test
      Returns:
      true if the altitude falls inside this band

    • midpoint

      public int midpoint()
      The altitude in this band a unit is likeliest to be found at, used when nothing better is known.
      Returns:
      the midpoint of the band

    • 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.

    • lowest

      public int lowest()
      Returns the value of the lowest record component.
      Returns:
      the value of the lowest record component

    • highest

      public int highest()
      Returns the value of the highest record component.
      Returns:
      the value of the highest record component