Skip to main content

ConversionUnit

Struct ConversionUnit 

Source
#[non_exhaustive]
pub struct ConversionUnit { pub name: Arc<str>, pub unit_type: Option<Arc<str>>, pub dimensions: [i32; 7], pub mantissa: f64, pub decimal_exponent: i32, pub offset: f64, }
Expand description

A unit reduced to its dimensions and its exact factor into SI base units.

value_si = value * mantissa * 10^decimal_exponent + offset.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: Arc<str>

How the unit was named: MILLI METRE, foot, or the model entity’s type and name.

§unit_type: Option<Arc<str>>

Its IfcUnitEnum or IfcDerivedUnitEnum constant, when it has one.

§dimensions: [i32; 7]

SI dimensional exponents [L, M, T, I, Θ, N, J].

§mantissa: f64

See the type note.

§decimal_exponent: i32

See the type note.

§offset: f64

Added after scaling; nonzero only for the SI DEGREE_CELSIUS.

Implementations§

Source§

impl ConversionUnit

Source

pub fn si(prefix: Option<&str>, name: &str) -> Result<Self, UnitConversionError>

An IfcSIUnit by name and optional prefix, e.g. (Some("MILLI"), "METRE") or (None, "SQUARE_METRE").

Names and dimensions are IFC4 ADD2 TC1’s IfcDimensionsForSiUnit (IFC4X3 ADD2 agrees); the unprefixed mass unit is the gram, as IfcSIUnit defines it.

§Errors

UnitConversionError::UnknownPrefix or UnitConversionError::UnknownUnit.

Source

pub fn named(name: &str) -> Result<Self, UnitConversionError>

A named conversion-based unit: an IFC4 Table 673 designation (inch, foot, square foot, gallon US, pound, degree …, case-insensitive) or US survey foot, with the exact factors of named_units.

§Errors

UnitConversionError::OffsetUnit for degree Fahrenheit (#110), UnitConversionError::UnknownUnit for any other name.

Source

pub fn parse(spec: &str) -> Result<Self, UnitConversionError>

A unit from text: an SI unit, with its prefix written before it (METRE, MILLIMETRE, MILLI METRE, MILLI_METRE, square millimetre, CUBIC_METRE, KILOGRAM; METER spellings accepted), or a named conversion-based unit (Self::named). Case-insensitive.

A prefix joined to a square or cubic name applies before the power, as in IFC: MILLI SQUARE_METRE and SQUARE_MILLIMETRE are both mm².

§Errors

As Self::si and Self::named.

Source

pub fn coherent_si(dimensions: [i32; 7]) -> Self

The coherent SI unit of dimensions: factor 1 into SI base units, no offset. A value in it is the SI value itself, so unit_conversion from it takes SI input into any unit of the same dimensions.

Source

pub fn scale(&self) -> f64

The factor into SI base units, mantissa * 10^decimal_exponent.

Source

pub fn is_length(&self) -> bool

Whether this is a length unit (dimensions [1, 0, 0, 0, 0, 0, 0]).

Trait Implementations§

Source§

impl Clone for ConversionUnit

Source§

fn clone(&self) -> ConversionUnit

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConversionUnit

Source§

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

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

impl PartialEq for ConversionUnit

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ConversionUnit

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.