Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

Quantities are numbers along with their units.


Compounds

class  Quantity

Functions

int convert ( Quantity* to, const Quantity* from )

Function Documentation

int convert ( Quantity * to,
const Quantity * from )
 

Convert a number from one set of units into another. The value for <to> will be overwritten by dtNaN if <to> and <from> do not belong to the same unit groups and do not have the same dimensionality.

Parameters:
to   the quantity containing the units to convert to. Note that the value of this quantity will be overwritten with the result or dtNaN if there was a problem.
from   the quantity containing the units and value to convert from.
Returns:
the return value is a 0 on success or 1 when units fail to match.
Citrus C++ Reference Manual  20010520