Adds code for IPC files

Author: DrPaulSharp

RATapi/controls.py

@@ -1,3 +1,6 @@
+import contextlib
+import os
+import tempfile
 import warnings
 
 import prettytable
@@ -70,6 +73,8 @@ class Controls(BaseModel, validate_assignment=True, extra="forbid"):
     pUnitGamma: float = Field(0.2, gt=0.0, lt=1.0)
     boundHandling: BoundHandling = BoundHandling.Reflect
     adaptPCR: bool = True
+    # Private field for IPC file
+    _IPCFilePath: str = ""
 
     @model_validator(mode="wrap")
     def warn_setting_incorrect_properties(self, handler: ValidatorFunctionWrapHandler) -> "Controls":
@@ -131,3 +136,23 @@ def __str__(self) -> str:
         table.field_names = ["Property", "Value"]
         table.add_rows([[k, v] for k, v in self.model_dump().items()])
         return table.get_string()
+
+    def initialise_IPC(self):
+        """Setup the inter-process communication file."""
+        IPCFile = tempfile.mkstemp()
+        self._IPCFilePath = IPCFile[1]
+        with open(self._IPCFilePath, "wb") as f:
+            f.write(b"0")
+        return None
+
+    def sendStopEvent(self):
+        """Sends the stop event via the inter-process communication file."""
+        with open(self._IPCFilePath, "wb") as f:
+            f.write(b"1")
+        return None
+
+    def delete_IPC(self):
+        """Delete the inter-process communication file."""
+        with contextlib.suppress(FileNotFoundError):
+            os.remove(self._IPCFilePath)
+        return None

RATapi/inputs.py

@@ -470,4 +470,6 @@ def make_controls(input_controls: RATapi.Controls, checks: Checks) -> Control:
     # IPC
     controls.IPCFilePath = ""
 
+    controls.IPCFilePath = input_controls._IPCFilePath
+
     return controls

RATapi/run.py

@@ -130,6 +130,8 @@ def run(project, controls):
         for index, value in enumerate(getattr(problem_definition, parameter_field[class_list])):
             getattr(project, class_list)[index].value = value
 
+    controls.delete_IPC()
+
     if display_on:
         print("Finished RAT " + horizontal_line)