feat: put Pathing as interface to MovePath

Author: Scoppio

megamek/src/megamek/client/bot/caspar/ClassificationScore.java

@@ -48,6 +48,7 @@ public boolean isHoldPosition() {
         return holdPosition > offensive && holdPosition > defensive;
     }
 
+    @Override
     public String toString() {
         return String.format("ClassificationScore<%s>[offensive=%.2f, defensive=%.2f, holdPosition=%.2f]",
               getClassification(), offensive, defensive, holdPosition);

megamek/src/megamek/client/bot/caspar/MovementClassification.java

@@ -32,6 +32,10 @@ public enum MovementClassification {
     DEFENSIVE(1),
     HOLD_POSITION(2);
 
+    /**
+     * The value associated with the movement classification.
+     * It is defined by how the tensorflow model was trained and the data generated and tagged.
+     */
     private final int value;
 
     MovementClassification(int value) {
@@ -53,4 +57,13 @@ public boolean isDefensive() {
     public boolean isHoldPosition() {
         return this == HOLD_POSITION;
     }
+
+    public static MovementClassification fromValue(int value) {
+        for (MovementClassification classification : values()) {
+            if (classification.value == value) {
+                return classification;
+            }
+        }
+        throw new IllegalArgumentException("Invalid value: " + value);
+    }
 }

megamek/src/megamek/common/MovePath.java

@@ -32,7 +32,7 @@
 /**
  * Holds movement path for an entity.
  */
-public class MovePath implements Cloneable, Serializable {
+public class MovePath implements Cloneable, Serializable, Pathing {
     private static final MMLogger logger = MMLogger.create(MovePath.class);
 
     private static final long serialVersionUID = -4258296679177532986L;
@@ -247,6 +247,7 @@ public MovePath(Game game, Entity entity, @Nullable Coords waypoint) {
      * Checks if there is a waypoint referenced by this MovePath.
      * @return true if there is a waypoint, false otherwise.
      */
+    @Override
     public boolean hasWaypoint() {
         return waypoint != null;
     }
@@ -255,10 +256,12 @@ public boolean hasWaypoint() {
      * Returns the waypoint referenced by this MovePath.
      * @return the waypoint, or null if there is none.
      */
+    @Override
     public @Nullable Coords getWaypoint() {
         return waypoint;
     }
 
+    @Override
     public Entity getEntity() {
         return entity;
     }
@@ -404,6 +407,7 @@ protected MovePath addStep(final MoveStep step) {
         return addStep(step, true);
     }
 
+    @Override
     public Set<Coords> getCoordsSet() {
         if (coordsSet != null) {
             return coordsSet;
@@ -993,6 +997,7 @@ public boolean hasActiveSupercharger() {
      *         path, or
      *         null if there's an issue with determining the coords
      */
+    @Override
     public @Nullable Coords getFinalCoords() {
         if (getGame().useVectorMove()) {
             return Compute.getFinalPosition(getEntity().getPosition(), getFinalVectors());
@@ -1006,6 +1011,7 @@ public boolean hasActiveSupercharger() {
     /**
      * Returns the starting {@link Coords} of this path.
      */
+    @Override
     public @Nullable Coords getStartCoords() {
         for (final Enumeration<MoveStep> e = getSteps(); e.hasMoreElements();) {
             final MoveStep step = e.nextElement();
@@ -1021,6 +1027,7 @@ public boolean hasActiveSupercharger() {
      * Returns the final facing if a mek were to perform all the steps in this
      * path.
      */
+    @Override
     public int getFinalFacing() {
         MoveStep last = getLastStep();
         if (last != null) {
@@ -1032,6 +1039,7 @@ public int getFinalFacing() {
     /**
      * Returns whether or not a unit would end up prone after all of the steps
      */
+    @Override
     public boolean getFinalProne() {
         if (getLastStep() != null) {
             return getLastStep().isProne();
@@ -1342,6 +1350,7 @@ public static int getAdjustedFacing(final int facing, final MoveStepType movemen
     /**
      * Returns the number of MPs used in the path
      */
+    @Override
     public int getMpUsed() {
         if (getLastStep() != null) {
             return getLastStep().getMpUsed();
@@ -1353,6 +1362,7 @@ public int getMpUsed() {
      * Returns the logical number of hexes moved the path (does not count turns,
      * etc).
      */
+    @Override
     public int getHexesMoved() {
         if (getLastStep() == null) {
             return 0;
@@ -1363,6 +1373,7 @@ public int getHexesMoved() {
     /**
      * Returns the linear distance between the first and last hexes in the path.
      */
+    @Override
     public int getDistanceTravelled() {
         var currentEntityPosition = getEntity().getPosition();
         if (currentEntityPosition == null) {
@@ -1378,6 +1389,7 @@ public int getDistanceTravelled() {
     /**
      * Returns true if the entity is jumping or if it's a flying lam.
      */
+    @Override
     public boolean isJumping() {
         return contains(MoveStepType.START_JUMP);
     }

megamek/unittests/megamek/ai/neuralnetwork/BrainTest.java

@@ -163,7 +163,7 @@ private static Collection<TestValue> loadTestValues() {
      */
     private static MovementClassification getMovementClassificationFromSplitLine(String[] values) {
         // The last value in the line is the classification
-        return MovementClassification.values()[Integer.parseInt(values[values.length-1])];
+        return MovementClassification.fromValue(Integer.parseInt(values[values.length-1]));
     }
 
     /**