#1816 - Added full documentation on the database client/server, and the internal frame processing process

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

@@ -10,6 +10,15 @@ from primaite.simulator.system.core.software_manager import SoftwareManager
 
 
 class DatabaseClient(Application):
+    """
+    A DatabaseClient application.
+
+    Extends the Application class to provide functionality for connecting, querying, and disconnecting from a
+    Database Service. It mainly operates over TCP protocol.
+
+    :ivar server_ip_address: The IPv4 address of the Database Service server, defaults to None.
+    """
+
     server_ip_address: Optional[IPv4Address] = None
     connected: bool = False
 
@@ -20,9 +29,21 @@ class DatabaseClient(Application):
         super().__init__(**kwargs)
 
     def describe_state(self) -> Dict:
+        """
+        Describes the current state of the ACLRule.
+
+        :return: A dictionary representing the current state.
+        """
+        pass
         return super().describe_state()
 
     def connect(self, server_ip_address: IPv4Address, password: Optional[str] = None) -> bool:
+        """
+        Connect to a Database Service.
+
+        :param server_ip_address: The IPv4 Address of the Node the Database Service is running on.
+        :param password: The Database Service password. Is optional and has a default value of None.
+        """
         if not self.connected and self.operating_state.RUNNING:
             return self._connect(server_ip_address, password)
 
@@ -44,6 +65,7 @@ class DatabaseClient(Application):
         return self._connect(server_ip_address, password, True)
 
     def disconnect(self):
+        """Disconnect from the Database Service."""
         if self.connected and self.operating_state.RUNNING:
             software_manager: SoftwareManager = self.software_manager
             software_manager.send_payload_to_session_manager(
@@ -54,6 +76,11 @@ class DatabaseClient(Application):
             self.server_ip_address = None
 
     def query(self, sql: str):
+        """
+        Send a query to the Database Service.
+
+        :param sql: The SQL query.
+        """
         if self.connected and self.operating_state.RUNNING:
             software_manager: SoftwareManager = self.software_manager
             software_manager.send_payload_to_session_manager(
@@ -75,6 +102,13 @@ class DatabaseClient(Application):
         print(table)
 
     def receive(self, payload: Any, session_id: str, **kwargs) -> bool:
+        """
+        Receive a payload from the Software Manager.
+
+        :param payload: A payload to receive.
+        :param session_id: The session id the payload relates to.
+        :return: True.
+        """
         if isinstance(payload, dict) and payload.get("type"):
             if payload["type"] == "connect_response":
                 self.connected = payload["response"] == True