Struct fmi::variable::Var

pub struct Var<I: Common> { /* fields omitted */ }

Var wraps access to an underlying ScalarVariable on an Instance

Methods

impl<I: Common> Var<I>

pub fn from_scalar_variable(instance: &Rc<I>, sv: &ScalarVariable) -> Self

Create a new Var from an Instance and a ScalarVariable

pub fn from_name(instance: &Rc<I>, name: &str) -> Result<Self>

Create a new Var from an Instance given a variable name

pub fn name(&self) -> &str

pub fn scalar_variable(&self) -> &ScalarVariable

pub fn instance(&self) -> &Rc<I>

pub fn get(&self) -> Result<Value>

pub fn set(&self, value: &Value) -> Result<()>

Trait Implementations

impl<I: Common> Ord for Var<I>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<I: Common> Eq for Var<I>

impl<I: Common> PartialOrd<Var<I>> for Var<I>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I: Common> PartialEq<Var<I>> for Var<I>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<I: Debug + Common> Debug for Var<I>

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

Formats the value using the given formatter.

impl<I: Common> Display for Var<I>

fn fmt(&self, _derive_more_Display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<I: Common> Hash for Var<I>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].