Struct Engine 

pub struct Engine<E, M: Model<E>> { /* private fields */ }

The engine responsible for simulation setup and initialization.

The Engine manages the registration of Hooks, Sources, and initial events required for model execution. Calling begin_simulation transitions the engine into an active ExecutorContext, freezing the configuration and preparing the engine for the main simulation loop.

Implementations

impl<E, M: Model<E>> Engine<E, M>

pub fn new() -> Engine<E, M>

Creates a new Engine instance.

pub fn begin_simulation(self, model: &M) -> ExecutorContext<E, M>

Initializes the simulation based on registered configurations and returns the ExecutorContext.

This process performs the following sequence:

1. Executes the before_simulation hook.
2. Initializes all registered sources (on_registered).
3. Propagates events generated during initialization to the event scheduler.

pub fn add_hook<H>(&mut self, hook: H) -> &mut Self

where H: Hook<E, M> + 'static,

Adds a simulation hook to the engine.

pub fn add_shared_hook<H>( &mut self, shared_hook: SharedHook<E, M, H>, ) -> &mut Self

where E: 'static, M: 'static, H: Hook<E, M> + 'static,

Adds a shared simulation hook to the engine.

pub fn add_source<S>(&mut self, name: &'static str, source: S) -> &mut Self

where S: Source<E, M> + 'static,

Registers a source before the simulation begins.

pub fn schedule_event_at( &mut self, sim_time: SimTime, priority: EventPriority, event_payload: E, ) -> &mut Self

Schedules an event to be processed when the simulation starts.

Trait Implementations

impl<E, M: Model<E>> Default for Engine<E, M>

fn default() -> Self

Returns the “default value” for a type.