fmi-export 0.2.0

FMU export support for FMI 3.0
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use std::{collections::BTreeMap, path::PathBuf};

use fmi::fmi3::Fmi3Status;

use crate::fmi3::{
    UserModel,
    instance::{IntermediateUpdateClosure, LogMessageClosure},
    traits::{Context, ModelLoggingCategory},
};

/// Basic context for Model-Exchange FMU instances
pub struct BasicContext<M: UserModel> {
    /// Map of logging categories to their enabled state.
    /// This is used to track which categories are enabled for logging.
    logging_on: BTreeMap<M::LoggingCategory, bool>,
    /// Callback for logging messages.
    log_message: LogMessageClosure,
    /// Path to the resources directory.
    resource_path: PathBuf,
    /// Simulation stop time.
    stop_time: Option<f64>,
    /// Current simulation time.
    time: f64,
    /// Whether early return is allowed for CS steps.
    early_return_allowed: bool,
    /// Optional FMI intermediate update callback (CS).
    intermediate_update: Option<IntermediateUpdateClosure>,
}

impl<M: UserModel> BasicContext<M> {
    pub fn new(
        logging_on: bool,
        log_message: LogMessageClosure,
        resource_path: PathBuf,
        early_return_allowed: bool,
        intermediate_update: Option<IntermediateUpdateClosure>,
    ) -> Self {
        let logging_on = <M as UserModel>::LoggingCategory::all_categories()
            .map(|category| (category, logging_on))
            .collect();
        Self {
            logging_on,
            log_message,
            resource_path,
            stop_time: None,
            time: 0.0,
            early_return_allowed,
            intermediate_update,
        }
    }

    pub fn intermediate_update(&self) -> Option<&IntermediateUpdateClosure> {
        self.intermediate_update.as_ref()
    }
}

impl<M> Context<M> for BasicContext<M>
where
    M: UserModel + 'static,
{
    fn logging_on(&self, category: <M as UserModel>::LoggingCategory) -> bool {
        matches!(self.logging_on.get(&category), Some(true))
    }

    fn set_logging(&mut self, category: <M as UserModel>::LoggingCategory, enabled: bool) {
        self.logging_on.insert(category, enabled);
    }

    /// Log a message if the specified logging category is enabled.
    fn log(&self, status: Fmi3Status, category: M::LoggingCategory, args: std::fmt::Arguments<'_>) {
        if self.logging_on(category) {
            // Call the logging callback
            (self.log_message)(status, &category.to_string(), args);
        }
    }

    /// Get the path to the resources directory.
    fn resource_path(&self) -> &PathBuf {
        &self.resource_path
    }

    fn initialize(&mut self, start_time: f64, stop_time: Option<f64>) {
        self.time = start_time;
        self.stop_time = stop_time;
    }

    fn time(&self) -> f64 {
        self.time
    }

    fn set_time(&mut self, time: f64) {
        self.time = time;
    }

    fn stop_time(&self) -> Option<f64> {
        self.stop_time
    }

    fn early_return_allowed(&self) -> bool {
        self.early_return_allowed
    }

    fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
        self
    }
}