Struct Fmu 

pub struct Fmu {
    pub model_description: FmiModelDescription,
    /* private fields */
}

A unpacked FMU with a parsed model description.

Fields

model_description: FmiModelDescription

Parsed model description XML.

Implementations

impl Fmu

pub fn unpack(fmu_path: impl Into<PathBuf>) -> Result<Self, FmuUnpackError>

Unpack an FMU file to a tempdir and parse it’s model description.

pub fn unpack_to( fmu_path: impl Into<PathBuf>, target_dir: impl Into<PathBuf>, ) -> Result<Self, FmuUnpackError>

Unpack an FMU file to a given target dir and parse it’s model description.

pub fn load(self, simulation_type: fmi2Type) -> Result<FmuLibrary, FmuLoadError>

Load the FMU dynamic library.

pub fn load_with_handler<F>( self, simulation_type: fmi2Type, handler: F, ) -> Result<FmuLibrary, FmuLoadError>

where F: FnOnce(&Library),

Load the FMU dynamic library, but pass in a handler to load custom symbols from the dynamic library before it’s passed to the runner.

This is useful for loading custom symbols and functions from the FMU library that are not part of the FMI standard.

Example

let mut register_handler: Option<force_injector::RegisterHandlerFn> = None;
let fmu = Fmu::unpack(Path::new("./tests/fmu/planar_ball.fmu"))
    .unwrap()
    .load_with_handler(fmi2Type::fmi2CoSimulation, |lib| {
        register_handler = unsafe { lib.get(b"register_handler\0") }
            .map(|sym| *sym)
            .ok();
    })
    .unwrap();

pub fn variables(&self) -> &HashMap<String, ScalarVariable>

Trait Implementations

impl Debug for Fmu

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

Formats the value using the given formatter.