IRelative |
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').
Namespace: Altaxo.Units
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3261.0 (4.8.3261.0)
SyntaxC#
public interface IRelativeUnit : IUnit
The IRelativeUnit type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Name | Full name of the unit. (Inherited from IUnit) |
| Prefixes |
Returns a list of possible prefixes for this unit (like µ, m, k, M, G..).
(Inherited from IUnit) |
| ReferenceQuantity | The corresponding quantity that this unit encapsulates. |
| ShortCut | Usual shortcut of the unit. (Inherited from IUnit) |
| SIUnit |
Returns the corresponding SI unit.
(Inherited from IUnit) |
Methods| Name | Description | |
|---|---|---|
 | FromSIUnit |
Converts x (in SI units) to the corresponding value in this unit.
(Inherited from IUnit) |
| GetRelativeValueFromValue | Calculated the dimensionless prefactor to multiply the 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'. |
| ToSIUnit |
Converts x to the corresponding SI unit.
(Inherited from IUnit) |
See Also