model: Implement internal clock

Author: rht

mesa/model.py

@@ -12,11 +12,13 @@
 from collections import defaultdict
 
 # mypy
-from typing import Any
+from typing import Any, Union
 
 from mesa.agent import Agent, AgentSet
 from mesa.datacollection import DataCollector
 
+TimeT = Union[float, int]
+
 
 class Model:
     """Base class for models in the Mesa ABM library.
@@ -67,6 +69,9 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.current_id = 0
         self._agents: defaultdict[type, dict] = defaultdict(dict)
 
+        self.steps = 0
+        self.time: TimeT = 0  # the model's clock
+
         # Warning flags for current experimental features. These make sure a warning is only printed once per model.
         self.agentset_experimental_warning_given = False
 
@@ -97,6 +102,11 @@ def run_model(self) -> None:
     def step(self) -> None:
         """A single step. Fill in here."""
 
+    def advance_time(self, deltat: TimeT = 1):
+        """Increment the model's steps counter and clock."""
+        self.steps += 1
+        self.time += deltat
+
     def next_id(self) -> int:
         """Return the next unique ID for agents, increment current_id"""
         self.current_id += 1

tests/test_batch_run.py

@@ -85,6 +85,7 @@ def get_local_model_param(self):
     def step(self):
         self.datacollector.collect(self)
         self.schedule.step()
+        self.advance_time()
 
 
 def test_batch_run():

tests/test_datacollector.py

@@ -89,6 +89,7 @@ def test_model_calc_comp(self, input1, input2):
     def step(self):
         self.schedule.step()
         self.datacollector.collect(self)
+        self.advance_time()
 
 
 class TestDataCollector(unittest.TestCase):

tests/test_lifespan.py

@@ -43,6 +43,7 @@ def step(self):
                 self.schedule.add(
                     FiniteLifeAgent(self.next_id(), self.agent_lifetime, self)
                 )
+        self.advance_time()
 
     def run_model(self, step_count=100):
         for _ in range(step_count):

tests/test_time.py

@@ -96,6 +96,7 @@ def __init__(self, shuffle=False, activation=STAGED, enable_kill_other_agent=Fal
 
     def step(self):
         self.schedule.step()
+        self.advance_time()
 
     def model_stage(self):
         self.log.append("model_stage")

tests/test_visualization.py

@@ -49,6 +49,7 @@ def __init__(self, width, height, key1=103, key2=104):
 
     def step(self):
         self.schedule.step()
+        self.advance_time()
 
 
 class TestModularServer(TestCase):