refactor: create abstract room artifact and switchable artifact abstraction

Author: AndreaGiulianelli

src/agt/temperatureControl.asl

@@ -42,7 +42,7 @@
 // Cooling goal
 +!turnOnCooling(RoomId) : not cooling(RoomId)
     <- .concat(RoomId, "-cooler", ResultString);
-       makeArtifact(ResultString, "artifact.environment.Cooler", [RoomId], CoolerId);
+       makeArtifact(ResultString, "artifact.environment.roomartifact.Cooler", [RoomId], CoolerId);
        turnOn [aid(CoolerId)];
        +cooling(RoomId); // add mental note to not re-turn on
        disposeArtifact(CoolerId).
@@ -51,7 +51,7 @@
 
 +!turnOffCooling(RoomId) : cooling(RoomId)
     <- .concat(RoomId, "-cooler", ResultString);
-       makeArtifact(ResultString, "artifact.environment.Cooler", [RoomId], CoolerId);
+       makeArtifact(ResultString, "artifact.environment.roomartifact.Cooler", [RoomId], CoolerId);
        turnOff [aid(CoolerId)];
        -cooling(RoomId); // remove mental note to not re-turn off
        disposeArtifact(CoolerId).
@@ -61,7 +61,7 @@
 // Heating goal
 +!turnOnHeating(RoomId) : not heating(RoomId)
     <- .concat(RoomId, "-heater", ResultString);
-       makeArtifact(ResultString, "artifact.environment.Heater", [RoomId], HeaterId);
+       makeArtifact(ResultString, "artifact.environment.roomartifact.Heater", [RoomId], HeaterId);
        turnOn [aid(HeaterId)];
        +heating(RoomId); // add mental note to not re-turn on
        disposeArtifact(HeaterId).
@@ -70,7 +70,7 @@
 
 +!turnOffHeating(RoomId) : heating(RoomId)
     <- .concat(RoomId, "-heater", ResultString);
-       makeArtifact(ResultString, "artifact.environment.Heater", [RoomId], HeaterId);
+       makeArtifact(ResultString, "artifact.environment.roomartifact.Heater", [RoomId], HeaterId);
        turnOff [aid(HeaterId)];
        -heating(RoomId); // remove mental note to not re-turn off
        disposeArtifact(HeaterId).

src/env/artifact/environment/roomartifact/AbstractRoomArtifact.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package artifact.environment.roomartifact;
+
+import cartago.Artifact;
+
+/**
+ * Abstract class that represent the base class for a CArtAgO boundary artifacts placed inside a Room within
+ * the Operating Block.
+ */
+public abstract class AbstractRoomArtifact extends Artifact {
+    private String roomId;
+
+    /**
+     * Initialize the artifact.
+     * This method is called by Jason agents.
+     * @param roomId the id of the room where the artifact is placed.
+     */
+    protected void init(final String roomId) {
+        this.roomId = roomId;
+    }
+
+    /**
+     * Obtain the roomId where the artifact is placed.
+     * @return the roomId.
+     */
+    public String getRoomId() {
+        return this.roomId;
+    }
+}

src/env/artifact/environment/Cooler.java src/env/artifact/environment/roomartifact/Cooler.java

@@ -6,9 +6,8 @@
  * https://opensource.org/licenses/MIT.
  */
 
-package artifact.environment;
+package artifact.environment.roomartifact;
 
-import cartago.Artifact;
 import cartago.OPERATION;
 
 import java.util.logging.Logger;
@@ -17,30 +16,16 @@
  * CArtAgO artifact that is responsible for the communication with the hvac system of the operating block respect
  * to the cooling part.
  */
-public class Cooler extends Artifact {
-    private String roomId;
-
-    /**
-     * Initialize the cooler artifact.
-     * @param roomId the id of the room where the cooler is placed
-     */
-    void init(final String roomId) {
-        this.roomId = roomId;
-    }
-
-    /**
-     * Turn on the cooling system.
-     */
+public class Cooler extends AbstractRoomArtifact implements SwitchableArtifact {
+    @Override
     @OPERATION
-    void turnOn() {
-        Logger.getLogger(Cooler.class.toString()).info("[" + this.roomId + "]" + " ON");
+    public final void turnOn() {
+        Logger.getLogger(Cooler.class.toString()).info("[" + this.getRoomId() + "]" + " ON");
     }
 
-    /**
-     * Turn off the cooling system.
-     */
+    @Override
     @OPERATION
-    void turnOff() {
-        Logger.getLogger(Cooler.class.toString()).info("[" + this.roomId + "]" + " OFF");
+    public final void turnOff() {
+        Logger.getLogger(Cooler.class.toString()).info("[" + this.getRoomId() + "]" + " OFF");
     }
 }

src/env/artifact/environment/Heater.java src/env/artifact/environment/roomartifact/Heater.java

@@ -6,9 +6,8 @@
  * https://opensource.org/licenses/MIT.
  */
 
-package artifact.environment;
+package artifact.environment.roomartifact;
 
-import cartago.Artifact;
 import cartago.OPERATION;
 
 import java.util.logging.Logger;
@@ -17,30 +16,16 @@
  * CArtAgO artifact that is responsible for the communication with the hvac system of the operating block respect
  * to the heating part.
  */
-public class Heater extends Artifact {
-    private String roomId;
-
-    /**
-     * Initialize the heater artifact.
-     * @param roomId the id of the room where the heater is placed
-     */
-    void init(final String roomId) {
-        this.roomId = roomId;
-    }
-
-    /**
-     * Turn on the heating system.
-     */
+public class Heater extends AbstractRoomArtifact implements SwitchableArtifact {
+    @Override
     @OPERATION
-    void turnOn() {
-        Logger.getLogger(Heater.class.toString()).info("[" + this.roomId + "]" + " ON");
+    public final void turnOn() {
+        Logger.getLogger(Heater.class.toString()).info("[" + this.getRoomId() + "]" + " ON");
     }
 
-    /**
-     * Turn off the heating system.
-     */
+    @Override
     @OPERATION
-    void turnOff() {
-        Logger.getLogger(Heater.class.toString()).info("[" + this.roomId + "]" + " OFF");
+    public final void turnOff() {
+        Logger.getLogger(Heater.class.toString()).info("[" + this.getRoomId() + "]" + " OFF");
     }
 }

src/env/artifact/environment/roomartifact/SwitchableArtifact.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2023. Smart Operating Block
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package artifact.environment.roomartifact;
+
+/**
+ * Interface that models a switchable artifact, that is an artifacts that offers method to turn it on and off.
+ */
+public interface SwitchableArtifact {
+    /**
+     * Turn the artifact on.
+     */
+    void turnOn();
+
+    /**
+     * Turn the artifact off.
+     */
+    void turnOff();
+}