Struct ModelDescription 

pub struct ModelDescription {
    pub public: bool,
    pub params: &'static [&'static str],
    pub attrs: &'static [&'static str],
    pub any_inputs: Option<bool>,
    pub trigger: Option<&'static [&'static str]>,
    pub persistent: Option<&'static [&'static str]>,
}

Description of a single model in Meta

Example implementation

use mosaik_api::types::ModelDescription;

const foo: ModelDescription = ModelDescription {
    public: true,
    params: &["init_val"],
    attrs: &["delta", "val"],
    trigger: Some(&["delta"]),
    any_inputs: None,
    persistent: None,
};

Fields

public: bool

Whether the model can be created directly.

params: &'static [&'static str]

The parameters given during creating of this model.

attrs: &'static [&'static str]

The input and output attributes of this model.

any_inputs: Option<bool>

Whether this model accepts inputs other than those specified in attrs.

trigger: Option<&'static [&'static str]>

The input attributes that trigger a step of the associated simulator. (Non-trigger attributes are collected and supplied to the simulator when it steps next.)

persistent: Option<&'static [&'static str]>

The output attributes that are persistent.

Implementations

impl ModelDescription

pub fn new( public: bool, params: &'static [&'static str], attrs: &'static [&'static str], ) -> Self

Creates a new ModelDescription with fields any_inputs, trigger and persistent set to None.

Trait Implementations

impl Clone for ModelDescription

fn clone(&self) -> ModelDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModelDescription

fn default() -> ModelDescription

Returns the “default value” for a type.

impl PartialEq for ModelDescription

fn eq(&self, other: &ModelDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModelDescription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelDescription