fmi-rs 0.3.0

Functional Mock-up Interface (FMI) for Rust
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

#![allow(non_snake_case)]

use crate::{
    fmi3::{
        self, FMU3, Implementation,
        log::DefaultLogger,
        native::{NativeLibrary, PLATFORM_TUPLE},
    },
    platform_binary_path,
    sim::SimulationError,
    zip::extract_zip_archive,
};
use std::{
    path::{Path, PathBuf},
    sync::Arc,
};
use tempfile::TempDir;

pub struct FMU3Builder {
    pub unzipdir: TempDir,
    pub model_description: crate::model_description::fmi3::ModelDescription,
    pub visible: bool,
    pub loggingOn: bool,
    pub logFile: Option<PathBuf>,
    pub logCalls: bool,
    pub printMessages: bool,
    pub eventModeUsed: bool,
    pub earlyReturnAllowed: bool,
    pub requiredIntermediateVariables: Vec<u32>,
}

impl FMU3Builder {
    pub fn new<P: AsRef<Path>>(fmu_path: &P) -> Result<Self, SimulationError> {
        let unzipdir = TempDir::new().map_err(SimulationError::io(fmu_path.as_ref()))?;

        extract_zip_archive(fmu_path, &unzipdir)?;

        let model_description = crate::model_description::fmi3::ModelDescription::from_path(
            &unzipdir.path().join("modelDescription.xml"),
        )?;

        Ok(Self {
            unzipdir,
            model_description,
            visible: false,
            loggingOn: false,
            logFile: None,
            logCalls: false,
            printMessages: true,
            eventModeUsed: true,
            earlyReturnAllowed: true,
            requiredIntermediateVariables: vec![],
        })
    }

    pub fn visible(mut self, visible: bool) -> Self {
        self.visible = visible;
        self
    }

    pub fn loggingOn(mut self, loggingOn: bool) -> Self {
        self.loggingOn = loggingOn;
        self
    }

    pub fn logCalls(mut self, logCalls: bool) -> Self {
        self.logCalls = logCalls;
        self
    }

    pub fn printMessages(mut self, printMessages: bool) -> Self {
        self.printMessages = printMessages;
        self
    }

    pub fn instantiate_me(&self, instanceName: &str) -> Result<Arc<FMU3>, SimulationError> {
        if let Some(me) = &self.model_description.modelExchange {
            let logger = Arc::new(if let Some(log_file) = &self.logFile {
                DefaultLogger::from_path(log_file).map_err(SimulationError::io(&log_file))?
            } else {
                DefaultLogger::default()
            });

            let file = platform_binary_path(&self.unzipdir, PLATFORM_TUPLE, &me.modelIdentifier);

            let implementation: Box<dyn Implementation> = Box::new(NativeLibrary::load(file)?);

            let resource_dir = self.unzipdir.path().join("resources");

            let resourcePath = if resource_dir.is_dir() {
                Some(resource_dir.as_path())
            } else {
                None
            };

            fmi3::FMU3::instantiateModelExchange(
                implementation,
                resourcePath,
                instanceName,
                &self.model_description.instantiationToken,
                self.visible,
                self.loggingOn,
                logger,
                self.logCalls,
            )
        } else {
            Err(SimulationError::InterfaceType)
        }
    }

    pub fn instantiate_cs(&self, instanceName: &str) -> Result<Arc<FMU3>, SimulationError> {
        if let Some(cs) = &self.model_description.coSimulation {
            let logger = Arc::new(if let Some(log_file) = &self.logFile {
                DefaultLogger::from_path(log_file).map_err(SimulationError::io(&log_file))?
            } else {
                DefaultLogger::default()
            });

            let file = platform_binary_path(&self.unzipdir, PLATFORM_TUPLE, &cs.modelIdentifier);

            let implementation: Box<dyn Implementation> = Box::new(NativeLibrary::load(file)?);

            let resource_dir = self.unzipdir.path().join("resources");

            let resourcePath = if resource_dir.is_dir() {
                Some(resource_dir.as_path())
            } else {
                None
            };

            FMU3::instantiateCoSimulation(
                implementation,
                resourcePath,
                instanceName,
                &self.model_description.instantiationToken,
                self.visible,
                self.loggingOn,
                self.eventModeUsed,
                self.earlyReturnAllowed,
                logger,
                self.logCalls,
                None,
            )
        } else {
            Err(SimulationError::InterfaceType)
        }
    }
}