Merge branch 'dev' into feature/1752-dns-server-and-client

src/primaite/simulator/system/applications/application.py

@@ -1,6 +1,6 @@
 from abc import abstractmethod
 from enum import Enum
-from typing import Any, Dict, List, Set
+from typing import Any, Dict, Set
 
 from primaite.simulator.system.software import IOSoftware
 
@@ -8,13 +8,12 @@ from primaite.simulator.system.software import IOSoftware
 class ApplicationOperatingState(Enum):
     """Enumeration of Application Operating States."""
 
-
-RUNNING = 1
-"The application is running."
-CLOSED = 2
-"The application is closed or not running."
-INSTALLING = 3
-"The application is being installed or updated."
+    RUNNING = 1
+    "The application is running."
+    CLOSED = 2
+    "The application is closed or not running."
+    INSTALLING = 3
+    "The application is being installed or updated."
 
 
 class Application(IOSoftware):
@@ -36,23 +35,23 @@ class Application(IOSoftware):
     @abstractmethod
     def describe_state(self) -> Dict:
         """
-        Describes the current state of the software.
+        Produce a dictionary describing the current state of this object.
 
-        The specifics of the software's state, including its health, criticality,
-        and any other pertinent information, should be implemented in subclasses.
+        Please see :py:meth:`primaite.simulator.core.SimComponent.describe_state` for a more detailed explanation.
 
-        :return: A dictionary containing key-value pairs representing the current state of the software.
+        :return: Current state of this object and child objects.
         :rtype: Dict
         """
-        pass
-
-    def apply_action(self, action: List[str]) -> None:
-        """
-        Applies a list of actions to the Application.
-
-        :param action: A list of actions to apply.
-        """
-        pass
+        state = super().describe_state()
+        state.update(
+            {
+                "opearting_state": self.operating_state.name,
+                "execution_control_status": self.execution_control_status,
+                "num_executions": self.num_executions,
+                "groups": list(self.groups),
+            }
+        )
+        return state
 
     def reset_component_for_episode(self, episode: int):
         """