syren 0.6.0

A parallel Rust framework for agent-based models with ECS storage, scheduling, messaging, environments, and optional GPU execution.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! Named scheduler scope inside a [`Model`](crate::model::Model).

use crate::engine::scheduler::Scheduler;

/// A named scheduler that shares the model's ECS world and boundary resources.
pub struct SubScheduler {
    name: String,
    scheduler: Scheduler,
}

impl SubScheduler {
    /// Creates an empty sub-scheduler.
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            scheduler: Scheduler::new(),
        }
    }

    /// Creates a sub-scheduler from an existing scheduler.
    pub fn with_scheduler(name: impl Into<String>, scheduler: Scheduler) -> Self {
        Self {
            name: name.into(),
            scheduler,
        }
    }

    /// Returns the sub-scheduler name.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Returns the scheduler.
    pub fn scheduler(&self) -> &Scheduler {
        &self.scheduler
    }

    /// Returns the scheduler mutably.
    pub fn scheduler_mut(&mut self) -> &mut Scheduler {
        &mut self.scheduler
    }
}