Struct swifco_rs::model::Model

pub struct Model {
    world: World,
    resources: Resources,
    initialized: bool,
    map_initialization: Option<Box<dyn MapInitialization>>,
    population_initialization: Option<Box<dyn PopulationInitialization>>,
    systems: Vec<Box<dyn System>>,
}

Model(seed)

The basic model object to hold sub-models and resources, and to run simulations.

Parameters:

seed - the random seed for this model. Default from entropy (i.e. “random”).

Fields

world: World

resources: Resources

initialized: bool

map_initialization: Option<Box<dyn MapInitialization>>

population_initialization: Option<Box<dyn PopulationInitialization>>

systems: Vec<Box<dyn System>>

Implementations

impl Model

pub fn new(seed: Option<u64>) -> Self

pub fn add_resource(&mut self, resource: &mut ResourceWrapper)

Add a resource to the model.

pub fn set_map_init(&mut self, init: &mut MapInitializationWrapper)

Set the model’s map initialization system.

pub fn set_pop_init(&mut self, init: &mut PopulationInitializationWrapper)

Set the model’s population initialization system.

pub fn add_system(&mut self, system: &mut SystemWrapper)

Add a system (sub-model) to the model.

pub fn run(self_: &PyCell<Self>, py: Python<'_>) -> PyResult<()>

Run the model.

fn _initialize(&mut self)

fn _step(&mut self) -> bool

fn _finalize(&mut self)

Trait Implementations

impl Default for Model

fn default() -> Model

Returns the “default value” for a type.

impl IntoPy<Py<PyAny>> for Model

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for Model

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

impl PyClassImpl for Model

const DOC: &'static str

Class doc string

const IS_BASETYPE: bool

#[pyclass(subclass)]

const IS_SUBCLASS: bool

#[pyclass(extends=…)]

const IS_MAPPING: bool

#[pyclass(mapping)]

type Layout = PyCell<Self>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerImpl<Model>

This handles following two situations:

fn for_all_items(visitor: &mut dyn FnMut(&PyClassItems))

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyMethods<Model> for PyClassImplCollector<Model>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Model

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work.

const NAME: &'static str

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.