IRelativeUnit Type

Namespace: Altaxo.Units
Assembly: AltaxoCore.Redist.dll
All Interfaces: IRelativeUnit , IUnit

Represents a unit that refers to a reference quantity. Example: 'Percent of page with' is a unit, which refers to the quantity 'page width' (which has the dimension of length). Thus this unit is a combination of a dimensionless unit (in the example: 'percent') and the reference quantity (in the example: 'page width'). This dimension of this unit is equal to the dimension of the reference quantity (i.e. in the above example 'length').

Instance members

Instance member Description

this.GetRelativeValueFromValue

Full Usage: this.GetRelativeValueFromValue

Parameters:
    x : float - Numerical value to convert.

Returns: float The prefactor to multiply the IRelativeUnit.ReferenceQuantity with in order to get the absolute quantity.
Modifiers: abstract

Calculated the dimensionless prefactor to multiply the IRelativeUnit.ReferenceQuantity with. Example: Given that the relative unit is 'percent of page with', a value of x=5 is converted to 0.05. The result can then be used to calculate the absolute quantity by multiplying the result of 0.05 with the 'page with'.

x : float

Numerical value to convert.

Returns: float

The prefactor to multiply the IRelativeUnit.ReferenceQuantity with in order to get the absolute quantity.

this.ReferenceQuantity

Full Usage: this.ReferenceQuantity

Returns: DimensionfulQuantity
Modifiers: abstract

The corresponding quantity that this unit encapsulates.

Returns: DimensionfulQuantity