Struct FmiString 

pub struct FmiString {

    pub name: String,
    pub value_reference: u32,
    pub description: Option<String>,
    pub causality: Option<Causality>,
    pub variability: Option<Variability>,
    pub can_handle_multiple_set_per_time_instant: Option<bool>,
    pub clocks: Option<AttrList<u32>>,
    pub declared_type: Option<String>,
    pub dimensions: Vec<Dimension>,
    pub intermediate_update: Option<bool>,
    pub previous: Option<u32>,
    pub start: Vec<StringStart>,
    pub initial: Option<Initial>,
    pub annotations: Option<Annotations>,
    pub aliases: Vec<VariableAlias>,
}

Fields

name: String

value_reference: u32

description: Option<String>

causality: Option<Causality>

variability: Option<Variability>

can_handle_multiple_set_per_time_instant: Option<bool>

clocks: Option<AttrList<u32>>

declared_type: Option<String>

dimensions: Vec<Dimension>

intermediate_update: Option<bool>

previous: Option<u32>

start: Vec<StringStart>

Initial or guess value of the variable. During instantiation, the FMU initializes its variables with their start values.

initial: Option<Initial>

annotations: Option<Annotations>

aliases: Vec<VariableAlias>

Implementations

impl FmiString

pub fn new( name: String, value_reference: u32, description: Option<String>, causality: Causality, variability: Variability, start: Option<Vec<String>>, initial: Option<Initial>, ) -> Self

Create a new FMI string variable with the given parameters

Trait Implementations

impl AbstractVariableTrait for FmiString

fn name(&self) -> &str

The full, unique name of the variable.

fn value_reference(&self) -> u32

A handle of the variable to efficiently identify the variable value in the model interface and for references within the modelDescription.xml

fn description(&self) -> Option<&str>

An optional description string describing the meaning of the variable.

fn causality(&self) -> Causality

Enumeration that defines the causality of the variable.

fn variability(&self) -> Variability

fn can_handle_multiple_set_per_time_instant(&self) -> Option<bool>

fn clocks(&self) -> Option<&[u32]>

fn data_type(&self) -> VariableType

fn annotations(&self) -> Option<&Annotations>

impl AppendToModelVariables for FmiString

fn append_to_variables(self, variables: &mut ModelVariables)

impl ArrayableVariableTrait for FmiString

fn dimensions(&self) -> &[Dimension]

Each Dimension element specifies the size of one dimension of the array

fn add_dimensions(&mut self, dims: &[Dimension])

Extend the dimensions of the variable

fn intermediate_update(&self) -> Option<bool>

If true, the variable can be updated during intermediate update mode.

fn previous(&self) -> Option<u32>

The value reference of the variable that provides the previous value of this variable.

impl Debug for FmiString

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

Formats the value using the given formatter.

impl Default for FmiString

fn default() -> FmiString

Returns the “default value” for a type.

impl InitializableVariableTrait for FmiString

type StartType = StringStart

fn initial(&self) -> Option<Initial>

fn start(&self) -> Option<&[Self::StartType]>

impl PartialEq for FmiString

fn eq(&self, other: &FmiString) -> 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 TypedVariableTrait for FmiString

fn declared_type(&self) -> Option<&str>

impl<'__input> XmlRead<'__input> for FmiString

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

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

impl XmlWrite for FmiString

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

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

impl StructuralPartialEq for FmiString