System.ConvUtils.RegisterConversionType

De Appmethod Libraries
Aller à : navigation, rechercher

Object Pascal

function RegisterConversionType(AConvTypeInfo: TConvTypeInfo; out AType: TConvType): Boolean;
function RegisterConversionType(const AFamily: TConvFamily; const ADescription: string; const AFactor: Double): TConvType;
function RegisterConversionType(const AFamily: TConvFamily; const ADescription: string; const AToCommonProc, AFromCommonProc: TConversionProc): TConvType;

C++

extern DELPHI_PACKAGE bool __fastcall RegisterConversionType(TConvTypeInfo* AConvTypeInfo, /* out */ TConvType &AType)/* overload */;

Propriétés

Type Visibilité  Source Unité  Parent
function public
System.ConvUtils.pas
System.ConvUtils.hpp
System.ConvUtils System.ConvUtils

Description

Recense un nouveau type de conversion et renvoie son identificateur.

Appelez RegisterConversionType pour ajouter un nouveau type de conversion (unité de mesure) à une famille de conversion recensée. La fonction globale Convert peut effectuer des conversions entre deux types de conversion quelconques recensés dans la même famille de conversion.

AFamily est l'identificateur pour la famille de conversion à laquelle le nouveau type de conversion appartient. Il peut s'agir de l'une des familles de conversion prédéfinies dans l'unité StdConvs ou de la valeur renvoyée par un appel à RegisterConversionFamily.

ADescription est une chaîne indiquant le nom du type de conversion. Il s'agit généralement de la forme au pluriel du nom de l'unité de mesure. Par exemple, la description pour le type de conversion duMeters est "Meters".

AFactor est le facteur par lequel une mesure utilisant le nouveau type de conversion doit être multiplié pour convertir les unités de base de la famille de conversion. Ainsi, par exemple, le facteur pour duKilometers a la valeur 1000, car l'unité de base pour la famille des distances est le mètre.

AToCommonProc et AFromCommonProc sont des fonctions qui effectuent une conversion entre le nouveau type de conversion et les unités de base pour la famille de conversion. Elles sont utilisées lorsque les conversions entre le nouveau type de conversion et les unités de base ne peuvent pas être effectuées par une simple multiplication. Par exemple, les mesures de température utilisent différentes valeurs pour le point 0 et requièrent par conséquent des fonctions de conversion plutôt qu'un facteur. AToCommonProc convertit des mesures dans le nouveau type de conversion vers les unités de base de la famille, alors que AFromCommonProc convertit des mesures des unités de base de la famille vers le nouveau type de conversion.

AConvTypeInfo est une instance d'un descendant de TConvTypeInfo qui représente le nouveau type de conversion. En entrée, ses propriétés ConvFamily et Description doivent être initialisées à l'aide de la famille de conversion qui contient le nouveau type de conversion et la chaîne qui indique le nom du nouveau type (similaires aux paramètres AFamily et ADescription). De plus, ses méthodes ToCommon et FromCommon effectuent les conversions entre le nouveau type de conversion et les unités de base de la famille de conversion (similaires aux paramètres AToCommonProc et AFromCommonProc). RegisterConversionType définit sa propriété ConvType, qui est également renvoyée comme paramètre AType. Lors de l'utilisation de cette syntaxe, RegisterConversionType renvoie true si le nouveau type est recensé avec succès, false si le nouveau type n'a pas pu être recensé (soit parce que la famille n'était pas recensée, soit parce que la description était déjà recensée).

Voir aussi