Struct Fmi3ModelDescription 

pub struct Fmi3ModelDescription {

    pub fmi_version: String,
    pub model_name: String,
    pub instantiation_token: String,
    pub description: Option<String>,
    pub author: 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 model_exchange: Option<Fmi3ModelExchange>,
    pub co_simulation: Option<Fmi3CoSimulation>,
    pub scheduled_execution: Option<Fmi3ScheduledExecution>,
    pub unit_definitions: Option<UnitDefinitions>,
    pub type_definitions: Option<TypeDefinitions>,
    pub log_categories: Option<LogCategories>,
    pub default_experiment: Option<DefaultExperiment>,
    pub model_variables: ModelVariables,
    pub model_structure: ModelStructure,
    pub annotations: Option<Annotations>,
}

Fields

fmi_version: String

Version of FMI that was used to generate the XML file.

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”.

instantiation_token: String

The instantiationToken is a string that can be used by the FMU to check that the XML file is compatible with the implementation of the FMU.

description: Option<String>

Optional string with a brief description of the model.

author: Option<String>

String with the name and organization of the model author.

version: Option<String>

Version of the model [for example 1.0].

copyright: Option<String>

Information on the intellectual property copyright for this FMU [for example © My Company 2011].

license: Option<String>

Information on the intellectual property licensing for this FMU (for example BSD license <license text or link to license>).

generation_tool: Option<String>

Name of the tool that generated the XML file.

generation_date_and_time: Option<String>

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.

model_exchange: Option<Fmi3ModelExchange>

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

co_simulation: Option<Fmi3CoSimulation>

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

scheduled_execution: Option<Fmi3ScheduledExecution>

If present, the FMU is based on FMI for Scheduled Execution

unit_definitions: Option<UnitDefinitions>

A global list of unit and display unit definitions

type_definitions: Option<TypeDefinitions>

A global list of type definitions that are utilized in ModelVariables

log_categories: Option<LogCategories>

Categories for logging purposes

default_experiment: Option<DefaultExperiment>

Providing default settings for the integrator, such as stop time and relative tolerance.

model_variables: ModelVariables

The model variables defined in the model.

model_structure: ModelStructure

The model structure defines the dependency structure of the model variables.

annotations: Option<Annotations>

Optional annotations for the top-level element.

Trait Implementations

impl Debug for Fmi3ModelDescription

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

Formats the value using the given formatter.

impl Default for Fmi3ModelDescription

fn default() -> Fmi3ModelDescription

Returns the “default value” for a type.

impl DefaultExperiment for Fmi3ModelDescription

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 Fmi3ModelDescription

fn model_name(&self) -> &str

Returns the model name

fn version_string(&self) -> &str

Returns the FMI version as a string

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

Serialize the model description to XML

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

Deserialize the model description from 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 PartialEq for Fmi3ModelDescription

fn eq(&self, other: &Fmi3ModelDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'__input> XmlRead<'__input> for Fmi3ModelDescription

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

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

impl XmlWrite for Fmi3ModelDescription

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

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

impl StructuralPartialEq for Fmi3ModelDescription