Update container docstrings

This commit is contained in:
Marek Wolan
2023-08-21 10:04:23 +01:00
parent 07b740a81e
commit 7e64acd368
2 changed files with 4 additions and 2 deletions

View File

@@ -5,12 +5,13 @@ from primaite.simulator.network.hardware.base import Link, Node
class NetworkContainer(SimComponent): class NetworkContainer(SimComponent):
"""TODO.""" """Top level container object representing the physical network."""
nodes: Dict[str, Node] = {} nodes: Dict[str, Node] = {}
links: Dict[str, Link] = {} links: Dict[str, Link] = {}
def __init__(self, **kwargs): def __init__(self, **kwargs):
"""Initialise the network."""
super().__init__(**kwargs) super().__init__(**kwargs)
self.action_manager = ActionManager() self.action_manager = ActionManager()

View File

@@ -6,12 +6,13 @@ from primaite.simulator.network.container import NetworkContainer
class Simulation(SimComponent): class Simulation(SimComponent):
"""TODO.""" """Top-level simulation object which holds a reference to all other parts of the simulation."""
network: NetworkContainer network: NetworkContainer
domain: DomainController domain: DomainController
def __init__(self, **kwargs): def __init__(self, **kwargs):
"""Initialise the Simulation."""
if not kwargs.get("network"): if not kwargs.get("network"):
kwargs["network"] = NetworkContainer() kwargs["network"] = NetworkContainer()