Struct Fmi2ModelDescription 

pub struct Fmi2ModelDescription {

    pub fmi_version: String,
    pub model_name: String,
    pub guid: String,
    pub description: Option<String>,
    pub version: Option<String>,
    pub copyright: Option<String>,
    pub license: Option<String>,
    pub generation_tool: Option<String>,
    pub generation_date_and_time: Option<String>,
    pub variable_naming_convention: Option<String>,
    pub number_of_event_indicators: Option<u32>,
    pub model_exchange: Option<ModelExchange>,
    pub co_simulation: Option<CoSimulation>,
    pub log_categories: Option<LogCategories>,
    pub default_experiment: Option<DefaultExperiment>,
    pub unit_definitions: Option<UnitDefinitions>,
    pub type_definitions: Option<TypeDefinitions>,
    pub model_variables: ModelVariables,
    pub model_structure: ModelStructure,
}

Fields

fmi_version: String

Version of FMI (Clarification for FMI 2.0.2: for FMI 2.0.x revisions fmiVersion is defined as “2.0”).

model_name: String

The name of the model as used in the modeling environment that generated the XML file, such as Modelica.Mechanics.Rotational.Examples.CoupledClutches.

guid: String

Fingerprint of xml-file content to verify that xml-file and C-functions are compatible to each other

description: Option<String>

version: Option<String>

Version of FMU, e.g., “1.4.1”

copyright: Option<String>

Information on intellectual property copyright for this FMU, such as “© MyCompany 2011”

license: Option<String>

Information on intellectual property licensing for this FMU, such as “BSD license”, “Proprietary”, or “Public Domain”

generation_tool: Option<String>

Name of the tool that generated the XML file.

generation_date_and_time: Option<String>

time/date of database creation according to ISO 8601 (preference: YYYY-MM-DDThh:mm:ss) Date and time when the XML file was generated. The format is a subset of dateTime and should be: YYYY-MM-DDThh:mm:ssZ (with one T between date and time; Z characterizes the Zulu time zone, in other words, Greenwich meantime) [for example 2009-12-08T14:33:22Z].

variable_naming_convention: Option<String>

Defines whether the variable names in <ModelVariables> and in <TypeDefinitions> follow a particular convention.

number_of_event_indicators: Option<u32>

FMI 2.0: Required for ModelExchange, ignored for Co-Simulation (may be absent).

model_exchange: Option<ModelExchange>

If present, the FMU is based on FMI for Model Exchange

co_simulation: Option<CoSimulation>

If present, the FMU is based on FMI for Co-Simulation

log_categories: Option<LogCategories>

default_experiment: Option<DefaultExperiment>

unit_definitions: Option<UnitDefinitions>

type_definitions: Option<TypeDefinitions>

model_variables: ModelVariables

model_structure: ModelStructure

Implementations

impl Fmi2ModelDescription

pub fn num_variables(&self) -> usize

Total number of variables

pub fn num_states(&self) -> usize

Get the number of continuous states (and derivatives)

pub fn num_event_indicators(&self) -> usize

pub fn get_model_variables(&self) -> impl Iterator<Item = &ScalarVariable>

Get a iterator of the SalarVariables

pub fn model_variable_by_name( &self, name: &str, ) -> Result<&ScalarVariable, Error>

Get a reference to the model variable with the given name

Trait Implementations

impl Debug for Fmi2ModelDescription

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

Formats the value using the given formatter.

impl Default for Fmi2ModelDescription

fn default() -> Fmi2ModelDescription

Returns the “default value” for a type.

impl DefaultExperiment for Fmi2ModelDescription

fn start_time(&self) -> Option<f64>

fn stop_time(&self) -> Option<f64>

fn tolerance(&self) -> Option<f64>

fn step_size(&self) -> Option<f64>

impl FmiModelDescription for Fmi2ModelDescription

fn model_name(&self) -> &str

Returns the model name

fn version_string(&self) -> &str

Returns the FMI version as a string

fn deserialize(xml: &str) -> Result<Self, Error>

Deserialize the model description from XML

fn serialize(&self) -> Result<String, Error>

Serialize the model description to XML

fn version(&self) -> Result<Version, Error>

Returns the parsed FMI version as a semver::Version

fn major_version(&self) -> Result<MajorVersion, Error>

Returns the parsed FMI version as a MajorVersion

impl FromStr for Fmi2ModelDescription

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'__input> XmlRead<'__input> for Fmi2ModelDescription

fn from_reader(reader: &mut XmlReader<'__input>) -> XmlResult<Self>

fn from_str(text: &'a str) -> Result<Self, XmlError>

impl XmlWrite for Fmi2ModelDescription

fn to_writer<W: Write>(&self, writer: &mut XmlWriter<W>) -> XmlResult<()>

fn to_string(&self) -> Result<String, XmlError>