Island: Add docstrings to {get,save}_simulation()
This commit is contained in:
parent
c58bbb3f8a
commit
d2906ef23b
|
@ -7,10 +7,22 @@ from monkey_island.cc.services.mode.mode_enum import IslandModeEnum
|
|||
class ISimulationRepository(ABC):
|
||||
@abstractmethod
|
||||
def save_simulation(self, simulation: Simulation):
|
||||
"""
|
||||
Save the simulation state
|
||||
|
||||
:param simulation: The simulation state
|
||||
:raises StorageError: If the simulation states could not be saved
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
def get_simulation(self) -> Simulation:
|
||||
"""
|
||||
Get the simulation state
|
||||
|
||||
:raises RetrievalError: If the simulation state could not be retrieved
|
||||
"""
|
||||
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
|
|
Loading…
Reference in New Issue