From 9e2ecbe5c07033e83b8f78715b2a5c8bcd86fa96 Mon Sep 17 00:00:00 2001
From: "Christian Y. Brenninkmeijer"
 <christian.brenninkmeijer@manchester.ac.uk>
Date: Mon, 21 Oct 2024 10:32:24 +0100
Subject: [PATCH] remane to short_str

---
 pacman/model/resources/abstract_sdram.py     |  4 ++--
 pacman/model/resources/constant_sdram.py     |  4 ++--
 pacman/model/resources/multi_region_sdram.py |  8 ++++----
 pacman/model/resources/shared_sdram.py       | 10 +++++-----
 pacman/model/resources/variable_sdram.py     |  4 ++--
 5 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/pacman/model/resources/abstract_sdram.py b/pacman/model/resources/abstract_sdram.py
index 613266cb3..06db3ad3c 100644
--- a/pacman/model/resources/abstract_sdram.py
+++ b/pacman/model/resources/abstract_sdram.py
@@ -83,7 +83,7 @@ def report(self, timesteps: Optional[int], indent: str = "",
 
     @property
     @abstractmethod
-    def _str(self) -> str:
+    def short_str(self) -> str:
         """
         A short string representation of this SDRAM.
 
@@ -92,4 +92,4 @@ def _str(self) -> str:
         raise NotImplementedError
 
     def __str__(self):
-        return f"SDRAM:{self._str}"
+        return f"SDRAM:{self.short_str}"
diff --git a/pacman/model/resources/constant_sdram.py b/pacman/model/resources/constant_sdram.py
index 8d42d903a..03fd778c4 100644
--- a/pacman/model/resources/constant_sdram.py
+++ b/pacman/model/resources/constant_sdram.py
@@ -68,6 +68,6 @@ def report(self, timesteps: Optional[int], indent: str = "",
         print(indent, preamble, f"Constant {self._sdram} bytes", file=target)
 
     @property
-    @overrides(AbstractSDRAM._str)
-    def _str(self):
+    @overrides(AbstractSDRAM.short_str)
+    def short_str(self):
         return f"fixed: {self._sdram}"
diff --git a/pacman/model/resources/multi_region_sdram.py b/pacman/model/resources/multi_region_sdram.py
index fe90a88e4..ea1b80fd3 100644
--- a/pacman/model/resources/multi_region_sdram.py
+++ b/pacman/model/resources/multi_region_sdram.py
@@ -49,7 +49,7 @@ class MultiRegionSDRAM(AbstractSDRAM):
     __slots__ = (
         # The regions of SDRAM, each of which is an AbstractSDRAM
         "__regions",
-        # The todal cost of all the regions
+        # The total cost of all the regions
         "__total")
 
     def __init__(self) -> None:
@@ -177,6 +177,6 @@ def per_timestep(self) -> float:
         return self.__total.per_timestep
 
     @property
-    @overrides(AbstractSDRAM._str)
-    def _str(self):
-        return f"Multi:{self.__total._str}"
+    @overrides(AbstractSDRAM.short_str)
+    def short_str(self):
+        return f"Multi:{self.__total.short_str}"
diff --git a/pacman/model/resources/shared_sdram.py b/pacman/model/resources/shared_sdram.py
index aaef641ad..cefeb2331 100644
--- a/pacman/model/resources/shared_sdram.py
+++ b/pacman/model/resources/shared_sdram.py
@@ -121,16 +121,16 @@ def report(self, timesteps: Optional[int], indent: str = "",
             sdram.report(timesteps, indent+"    ", key+":", target)
 
     @property
-    @overrides(AbstractSDRAM._str)
-    def _str(self):
+    @overrides(AbstractSDRAM.short_str)
+    def short_str(self):
         if self._per_core.fixed > 0 or self._per_core.per_timestep > 0:
-            per_core = f"per-core: {self._per_core._str} "
+            per_core = f"per-core: {self._per_core.short_str} "
         else:
             per_core = ""
         shared: Optional[str] = None
         for key, sdram in self._shared.items():
             if shared is None:
-                shared = f"shared:{key}: {sdram._str}"
+                shared = f"shared:{key}: {sdram.short_str}"
             else:
-                shared = f" {key}: {sdram._str}"
+                shared = f" {key}: {sdram.short_str}"
         return per_core + shared
diff --git a/pacman/model/resources/variable_sdram.py b/pacman/model/resources/variable_sdram.py
index 5f63e2a01..03e75dd93 100644
--- a/pacman/model/resources/variable_sdram.py
+++ b/pacman/model/resources/variable_sdram.py
@@ -108,7 +108,7 @@ def report(self, timesteps: Optional[int], indent: str = "",
               f"for a total of {self.get_total_sdram(timesteps)}", file=target)
 
     @property
-    @overrides(AbstractSDRAM._str)
-    def _str(self):
+    @overrides(AbstractSDRAM.short_str)
+    def short_str(self):
         return (f"fixed:{self._fixed_sdram} "
                 f"per_timestep:{self._per_timestep_sdram}")