register_begin_sample_callback¶
- passengersim.callbacks.register_begin_sample_callback(callback: Callable[[CallbackMixin], dict | None] | GenericTracer)¶
Register a function to be triggered at the beginning of each sample.
The callback function will be triggered after initial setup including all RM steps for the initial DCP, but before any customers can arrive.
- Parameters:
- callback : Callable[[Simulation], dict | None]¶
The callback function to register. It should accept a single argument, which will be the Simulation object, and return a dictionary of interesting things to store, or nothing.