Qt4Pi

TXSLib : Class TNumberCruncher

Cette classe permet de formater un nombre en chaine de caractères.

Pour des détails concernant le formatage des nombres se reporter à la rubrique : Formatage des nombres.

Fonctions publiques

	TNumberCruncher(QObject *parent = nullptr)
void	Copy(TNumberCruncher* pTarget)
QString	Format(const double& RealValue)
QString	Format(const int8_t& DecimalValue)
QString	Format(const int16_t& DecimalValue)
QString	Format(const int32_t& DecimalValue)
QString	Format(const int64_t& DecimalValue)
QString	Format(const uint8_t& DecimalValue)
QString	Format(const uint16_t& DecimalValue)
QString	Format(const uint32_t& DecimalValue)
QString	Format(const QDateTime& DateTimeValue)
void	SetFormat(uint DigitsBefore = 3, uint nDigitsAfter = 3, TXS::NumberFormat FormatDirective = TXS::NumberFormat_Any_Compact, TXS::TimeFormat TimeFormat = TXS::TimeFormat_SSfff)

Propriétés

Propriétés	Type	Ecriture	Lecture
DigitsAfterDecimalSeparator	uint	SetDigitsAfterDecimalSeparator	GetDigitsAfterDecimalSeparator
DigitsBeforeDecimalSeparator	uint	SetDigitsBeforeDecimalSeparator	GetDigitsBeforeDecimalSeparator
DigitsForIntegers	uint	SetDigitsForIntegers	GetDigitsForIntegers
EnableGroupSeparator	bool	SetEnableGroupSeparator	GetEnableGroupSeparator
ForceCLocal	bool	SetForceCLocal	GetForceCLocal
ForceSign	bool	SetForceSign	GetForceSign
MessageOverflow	QString	SetMessageOverflow	GetMessageOverflow
NumberFormat	TXS::NumberFormat	SetNumberFormat	GetNumberFormat
PadCharacter	QChar	SetPadCharacter	GetPadCharacter
ShowXOB	bool	SetShowXOB	GetShowXOB
TimeFormat	TXS::TimeFormat	SetTimeFormat	GetTimeFormat
UpperXOB	bool	SetUpperXOB	GetUpperXOB
XOBFormat	TXS::XOBFormat	SetXOBFormat	GetXOBFormat

TNumberCruncher::TNumberCruncher(QObject *parent = nullptr)

Description : Contructeur par défaut. Instancie un objet de la classe TNumberCruncher.

void TNumberCruncher::Copy(TNumberCruncher* pTarget)

Description : Copie toutes les propriétés de l'objet passé en paramètre vers les propriétés de cet objet.

Paramètre : pTarget - type TNumberCruncher* - Objet TNumberCrunsher source

void TNumberCruncher::SetFormat(uint DigitsBefore = 3, uint nDigitsAfter = 3, TXS::NumberFormat FormatDirective = TXS::NumberFormat_Any_Compact, TXS::TimeFormat TimeFormat = TXS::TimeFormat_SSfff)

Description : Cette fonction est un raccourci vers les fonctions d'écriture des propriétés DigitsBeforeDecimalSeparator, DigitsAfterDecimalSeparator, NumberFormat et TimeFormat.

Paramètre : DigitsBefore - type uint& - Valeur à attribuer à la propriété DigitsBeforeDecimalSeparator

Paramètre : nDigitsAfter - type uint& - Valeur à attribuer à la propriété DigitsAfterDecimalSeparator

Paramètre : FormatDirective - type TXS::NumberFormat& - Valeur à attribuer à la propriété NumberFormat

Paramètre : TimeFormat - type TXS::TimeFormat& - Valeur à attribuer à la propriété TimeFormat

void TNumberCruncher::Format(const double& RealValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : RealValue - type double& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const int8_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type int8_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const int16_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type int16_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const int32_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type int32_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const int64_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type int64_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const uint8_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type uint8_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const uint16_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type uint16_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const uint32_t& DecimalValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DecimalValue - type uint32_t& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

void TNumberCruncher::Format(const QDateTime& DateTimeValue)

Description : Cette fonction formate la valeur passée en paramètre.

Paramètre : DateTimeValue - type QDateTime& - Valeur à à formater

Valeur de retour : Valeur formatée sous forme de chaine de caractères. Si le format ou les paramètres de formatage ne s'appliquent pas, la valeur retournée sera une chaine vide.

NumberFormat

Description : Cette propriété définie le format de formatage des nombres ou date et heure.

Type : TXS::NumberFormat

Valeur par défaut : TXS::NumberFormat_Any_Compact

Ecriture : void SetNumberFormat(const TXS::NumberFormat& Format)

Lecture : TXS::NumberFormat GetNumberFormat()

TimeFormat

Description : Cette propriété définie le format de formatage des dates et heures. Ne s'applique que si la propriété NumberFormat est réglée à la valeur "NumberFormat_DateTime"

Type :TXS::TimeFormat

Valeur par défaut : TXS::TXS::TimeFormat_SSfff

Ecriture : void SetTimeFormat(const TXS::TimeFormat_SSfff& Format)

Lecture : TXS::TimeFormat_SSfff GetTimeFormat()

DigitsBeforeDecimalSeparator

Description : Cette propriété définie le nombre de chiffres significatifs avant le séparateur décimal lors du formatage de valeurs réelles.

Type : uint

Valeur par défaut : 3

Ecriture : void SetDigitsBeforeDecimalSeparator(const uint& nDigits)

Lecture : uint GetDigitsBeforeDecimalSeparator()

DigitsAfterDecimalSeparator

Description : Cette propriété définie le nombre de chiffres significatifs après le séparateur décimal lors du formatage de valeurs réelles.

Type : uint

Valeur par défaut : 3

Ecriture : void SetDigitsAfterDecimalSeparator(const uint& nDigits)

Lecture : uint GetDigitsAfterDecimalSeparator()

DigitsForIntegers

Description : Cette propriété définie le nombre de chiffres significatifs lors du formatage de valeurs entières.

Type : uint

Valeur par défaut : 6

Ecriture : void SetDigitsForIntegers(const uint& nDigits)

Lecture : uint GetDigitsForIntegers()

ForceSign

Description : Cette propriété définie si le signe doit être affiché dans tous les cas.

Type : bool

Valeur par défaut false

Ecriture : void SetForceSign(const bool& tF)

Lecture : bool GetForceSign()

PadCharacter

Description : Cette propriété définie le caractère de complément lorsque le nombre de chiffres significatifs est inférieur à la consigne.

Type : QChar

Valeur par défaut _

Ecriture : void SetPadCharacter(const QChar& char)

Lecture : QChar GetPadCharacter()

MessageOverflow

Description : Cette propriété définie la chaine à retourner en cas de dépassement de gamme.

Type : QString

Valeur par défaut OVL

Ecriture : void SetMessageOverflow(const QString& str)

Lecture : QString GetMessageOverflow()

ForceCLocal

Description : Cette propriété définie si le formatage doit respecter la norme du lanage C plutôt que delui de la langue locale. Dans ce cas le séparateur décimalsera le point '.'. A noter que ce format interdit les séparations de groupes. La propriété EnableGroupSeparator est donc sans effet lorsque cette propriété est placée à true.

Type : bool

Valeur par défaut false

Ecriture : void SetForceCLocal(const bool& tF)

Lecture : bool GetForceCLocal()

EnableGroupSeparator

Description : Cette propriété définie si le nombre retourné inclus un espace entre chaque groupe de 3 chiffres significatifs.

Type : bool

Valeur par défaut true

Ecriture : void EnableGroupSeparator(const bool& tF)

Lecture : bool GetEnableGroupSeparator()

XOBFormat

Description : Cette propriété définie le groupement des chiffres et lettres lors du formatage en bases binaire, octodécimale et hexadécimale.

Type : TXS::XOBFormat

Valeur par défaut : TXS::XOBFormat_None

Ecriture : void SetXOBFormat(const TXS::XOBFormat& Format)

Lecture : TXS::XOBFormat GetXOBFormat()

ShowXOB

Description : Cette propriété définie si le nombre retourné inclus le préfixe de base lors du formatage en bases binaire, octodécimale et hexadécimale.

Type : bool

Valeur par défaut true

Ecriture : void SetShowXOB(const bool& tF)

Lecture : bool GetShowXOB()

UpperXOB

Description : Cette propriété définie si le nombre retourné incluant le préfixe de base lors du formatage en bases binaire, octodécimale et hexadécimale doit être ou pas en majuscules. Cela concerne également les lettres dans une valeur hexadécimale.

Type : bool

Valeur par défaut false

Ecriture : void SetUpperXOB(const bool& tF)

Lecture : bool GetUpperXOB()