System.ConvUtils.TConvTypeFactor.ToCommon

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function ToCommon(const AValue: Double): Double; override;

C++

virtual double __fastcall ToCommon(const double AValue);

Properties

Type Visibility Source Unit Parent
function public
System.ConvUtils.pas
System.ConvUtils.hpp
System.ConvUtils TConvTypeFactor

Description

Converts measurements in the units represented by this conversion type to the base units of the conversion family.

ToCommon provides part of the underlying implementation of the global Convert function. In order to convert a measurement from one set of units to another, Convert calls the ToCommon method of the source conversion type's TConvTypeFactor instance to obtain the measurement in the base units of the conversion family, and then calls the ToCommon method of the destination conversion type's TConvTypeFactor instance to obtain the measurement in the destination units.

AValue is a value expressed in the units represented by this conversion type.

ToCommon multiplies AValue by the value of the Factor property and returns the result.

See Also