Struct StepContext 

pub struct StepContext<'a, S, A, Props, R, Sch>
where
    A: Agent,
{ /* private fields */ }

Safe context passed to agent step functions.

Provides mutable access to space, properties, RNG, and the deferred-action buffer without aliasing the agent store or the current agent’s borrow.

Type parameters

• S - the space type
• A - the agent type
• Props - user-defined model properties
• R - the RNG type
• Sch - the scheduler type

Implementations

impl<'a, S, A, Props, R, Sch> StepContext<'a, S, A, Props, R, Sch>

where A: Agent,

pub fn space(&self) -> &S

Immutable reference to the simulation space.

pub fn space_mut(&mut self) -> &mut S

Mutable reference to the simulation space.

pub fn properties(&self) -> &Props

Immutable reference to user-defined model properties.

pub fn properties_mut(&mut self) -> &mut Props

Mutable reference to user-defined model properties.

pub fn rng(&mut self) -> &mut R

Mutable reference to the model’s RNG.

pub fn scheduler(&mut self) -> &mut Sch

Mutable reference to the scheduler (rarely needed by user code).

pub fn defer_remove_agent(&mut self, id: AgentId)

Schedule an agent for removal after the current step completes.

With StandardModel::step, the removal is applied to the store only. With StandardModel::step_spatial, the removal is applied to both the store and the spatial index.

pub fn defer_insert_agent(&mut self, agent: A)

Schedule an agent for insertion after the current step completes.

With StandardModel::step, the insertion is applied to the store only. With StandardModel::step_spatial, the insertion is applied to both the store and the spatial index.