Fmi3ModelDescription

Struct Fmi3ModelDescription 

Source
pub struct Fmi3ModelDescription {
Show 21 fields 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 ].

§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 and in 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>§default_experiment: Option<DefaultExperiment>

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

§model_variables: ModelVariables§model_structure: ModelStructure

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

§annotations: Option<Annotations>

Trait Implementations§

Source§

impl Debug for Fmi3ModelDescription

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Fmi3ModelDescription

Source§

fn default() -> Fmi3ModelDescription

Returns the “default value” for a type. Read more
Source§

impl DefaultExperiment for Fmi3ModelDescription

Source§

impl FmiModelDescription for Fmi3ModelDescription

Source§

fn model_name(&self) -> &str

Returns the model name
Source§

fn version_string(&self) -> &str

Returns the FMI version as a string
Source§

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

Returns the parsed FMI version as a semver::Version
Source§

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

Returns the parsed FMI version as a MajorVersion
Source§

impl FromStr for Fmi3ModelDescription

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for Fmi3ModelDescription

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl YaDeserialize for Fmi3ModelDescription

Source§

fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>

Source§

impl YaSerialize for Fmi3ModelDescription

Source§

fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>

Source§

fn serialize_attributes( &self, source_attributes: Vec<OwnedAttribute>, source_namespace: Namespace, ) -> Result<(Vec<OwnedAttribute>, Namespace), String>

Source§

impl StructuralPartialEq for Fmi3ModelDescription

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.