#[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
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: f64See the type note.
decimal_exponent: i32See the type note.
offset: f64Added after scaling; nonzero only for the SI DEGREE_CELSIUS.
Implementations§
Source§impl ConversionUnit
impl ConversionUnit
Sourcepub fn si(prefix: Option<&str>, name: &str) -> Result<Self, UnitConversionError>
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.
Sourcepub fn named(name: &str) -> Result<Self, UnitConversionError>
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.
Sourcepub fn parse(spec: &str) -> Result<Self, UnitConversionError>
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.
Sourcepub fn coherent_si(dimensions: [i32; 7]) -> Self
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.
Trait Implementations§
Source§impl Clone for ConversionUnit
impl Clone for ConversionUnit
Source§fn clone(&self) -> ConversionUnit
fn clone(&self) -> ConversionUnit
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more