Struct QuantityDescriptor 

pub struct QuantityDescriptor {
    pub key: &'static str,
    pub si_label: &'static str,
    pub us_label: &'static str,
    pub si_to_us_scale: f64,
    pub si_to_us_offset: f64,
    pub si_decimals: u8,
    pub us_decimals: u8,
}

Descriptor of one physical quantity in an engine’s catalog (spec §5).

Quantity keys are engine-scoped: two engines may both declare a flow quantity without their descriptors agreeing, because no value ever crosses between engines.

Fields

key: &'static str

Stable quantity identifier, opaque to this layer; referenced by attribute schemas (spec §4.4) and result variables (spec §6).

si_label: &'static str

Unit text in the SI display system (e.g. “m”, “L/s”, “mm/hr”).

us_label: &'static str

Unit text in the US-customary display system (e.g. “ft”, “gpm”).

si_to_us_scale: f64

Scale of the affine SI→US display conversion: us = si * si_to_us_scale + si_to_us_offset.

si_to_us_offset: f64

Offset of the affine SI→US display conversion. Zero for all but temperature-like quantities.

si_decimals: u8

Suggested display precision in the SI system. Advisory.

us_decimals: u8

Suggested display precision in the US system. Advisory.

Implementations

impl QuantityDescriptor

pub fn label(&self, family: DisplayFamily) -> &'static str

The unit label for one display family.

pub fn from_si(&self, si: f64, family: DisplayFamily) -> f64

Re-express an SI display value in family.

pub fn decimals(&self, family: DisplayFamily) -> u8

The advisory display precision for one family.

impl QuantityDescriptor

pub fn si_to_us(&self, si: f64) -> f64

Convert a value from the SI display unit to the US display unit.

pub fn us_to_si(&self, us: f64) -> f64

Convert a value from the US display unit back to the SI display unit — the exact inverse of Self::si_to_us.

Trait Implementations

impl Clone for QuantityDescriptor

fn clone(&self) -> QuantityDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for QuantityDescriptor

impl Debug for QuantityDescriptor

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

Formats the value using the given formatter.

impl PartialEq for QuantityDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QuantityDescriptor

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 QuantityDescriptor