Enum StateVariableConfig 

pub enum StateVariableConfig {
    Distance {
        initial: Length,
        accumulator: bool,
        output_unit: Option<DistanceUnit>,
    },
    Time {
        initial: Time,
        accumulator: bool,
        output_unit: Option<TimeUnit>,
    },
    Speed {
        initial: Velocity,
        accumulator: bool,
        output_unit: Option<SpeedUnit>,
    },
    Energy {
        initial: Energy,
        accumulator: bool,
        output_unit: Option<EnergyUnit>,
    },
    Ratio {
        initial: Ratio,
        accumulator: bool,
        output_unit: Option<RatioUnit>,
    },
    Temperature {
        initial: ThermodynamicTemperature,
        accumulator: bool,
        output_unit: Option<TemperatureUnit>,
    },
    Custom {
        custom_type: String,
        value: CustomVariableConfig,
        accumulator: bool,
    },
}

Variants

Distance

Fields

initial: Length

accumulator: bool

output_unit: Option<DistanceUnit>

Time

Fields

initial: Time

accumulator: bool

output_unit: Option<TimeUnit>

Speed

Fields

initial: Velocity

accumulator: bool

output_unit: Option<SpeedUnit>

Energy

Fields

initial: Energy

accumulator: bool

output_unit: Option<EnergyUnit>

Ratio

Fields

initial: Ratio

accumulator: bool

output_unit: Option<RatioUnit>

Temperature

Fields

initial: ThermodynamicTemperature

accumulator: bool

output_unit: Option<TemperatureUnit>

Custom

Fields

custom_type: String

value: CustomVariableConfig

accumulator: bool

Implementations

impl StateVariableConfig

pub fn initial_value(&self) -> Result<StateVariable, StateModelError>

pub fn is_accumulator(&self) -> bool

pub fn get_custom_feature_format( &self, ) -> Result<&CustomVariableConfig, StateModelError>

pub fn get_unit_name(&self) -> Option<String>

the stringified name of the variable’s output unit, if set by user. if None, it implies the output unit is the Default implementation of the Unit type.

pub fn get_unit_name_or_default(&self) -> String

pub fn get_feature_type(&self) -> String

pub fn serialize_variable( &self, state_variable: &StateVariable, ) -> Result<Value, StateModelError>

Trait Implementations

impl Clone for StateVariableConfig

fn clone(&self) -> StateVariableConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateVariableConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StateVariableConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StateVariableConfig

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

Formats the value using the given formatter.

impl PartialEq for StateVariableConfig

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for StateVariableConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateVariableConfig