Struct fmu_runner::FmuInstance

pub struct FmuInstance<C: Borrow<FmuLibrary>> {
    pub lib: C,
    /* private fields */
}

A simulation “instance”, ready to execute.

Fields

lib: C

The loaded dll library.

This is generic behind the Borrow trait so that the user can pass in a reference or different Cell types such as [Arc].

The presence of this enforces that the FmuLibrary will outlive the FmuInstance.

Implementations

impl<C: Borrow<FmuLibrary>> FmuInstance<C>

pub fn instantiate(lib: C, logging_on: bool) -> Result<Self, FmuError>

Call fmi2Instantiate() on the FMU library to start a new simulation instance.

pub fn get_set_state_capability( &self ) -> Option<FmuGetSetStateCapability<'_, C>>

pub fn serialize_state_capability( &self ) -> Option<FmuSerializeStateCapability<'_, C>>

pub fn get_types_platform(&self) -> &str

pub fn set_debug_logging( &self, logging_on: bool, log_categories: &[&str] ) -> Result<(), FmuError>

pub fn setup_experiment( &self, start_time: f64, stop_time: Option<f64>, tolerance: Option<f64> ) -> Result<(), FmuError>

pub fn enter_initialization_mode(&self) -> Result<(), FmuError>

pub fn exit_initialization_mode(&self) -> Result<(), FmuError>

pub fn get_reals<'fmu>( &'fmu self, signals: &[&'fmu ScalarVariable] ) -> Result<HashMap<&ScalarVariable, fmi2Real>, FmuError>

pub fn get_integers<'fmu>( &'fmu self, signals: &[&'fmu ScalarVariable] ) -> Result<HashMap<&ScalarVariable, fmi2Integer>, FmuError>

pub fn get_booleans<'fmu>( &'fmu self, signals: &[&'fmu ScalarVariable] ) -> Result<HashMap<&ScalarVariable, fmi2Integer>, FmuError>

pub fn set_reals( &self, value_map: &HashMap<&ScalarVariable, fmi2Real> ) -> Result<(), FmuError>

pub fn set_integers( &self, value_map: &HashMap<&ScalarVariable, fmi2Integer> ) -> Result<(), FmuError>

pub fn set_booleans( &self, value_map: &HashMap<&ScalarVariable, fmi2Integer> ) -> Result<(), FmuError>

pub fn do_step( &self, current_communication_point: fmi2Real, communication_step_size: fmi2Real, no_set_fmustate_prior_to_current_point: bool ) -> Result<(), FmuError>

Trait Implementations

impl<C: Borrow<FmuLibrary>> Drop for FmuInstance<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Borrow<FmuLibrary>> Send for FmuInstance<C>