UDecimalFullFormatter Class Reference

#include "DecimalFullFormatter.h"

Public Member Functions
	UDecimalFullFormatter ()
virtual void	OnAppendToString (const FBigInteger &number, FString &string) const override
bool	GetUseGrouping () const
void	SetUseGrouping (bool value)
bool	GetAlwaysSign () const
void	SetAlwaysSign (bool value)
Public Member Functions inherited from UBigIntegerFormatter
FString	ToString (const FBigInteger &Number) const
FString &	AppendToString (const FBigInteger &Number, UPARAM(ref) FString &String) const
virtual int32	GetRadix () const
virtual void	OnAppendToString (const FBigInteger &number, FString &string) const

Static Public Member Functions
static FString	ToFullString (const FBigInteger &number)
static void	AppendFullToString (const FBigInteger &number, FString &string)
static UDecimalFullFormatter *	GetDefault ()

Additional Inherited Members
Static Protected Member Functions inherited from Duke::MCultureAwareObject
static const FCulture &	GetCulture ()
static void	AppendPrefix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign, FString &string)
static void	AppendSuffix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign, FString &string)
static int32	EstimateNumberLength (int32 numDecimalDigits, bool isNegative, bool alwaysSign, const FDecimalNumberFormattingRules &rules, const FNumberFormattingOptions &options)
static int32	EstimatePrefix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign)
static int32	EstimateSuffix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign)
static void	ReserveSpaceForNumber (int32 numDecimalDigits, bool isNegative, bool alwaysSign, const FDecimalNumberFormattingRules &rules, const FNumberFormattingOptions &options, FString &string)
static void	AppendAffix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign, const FString &negative, const FString &positive, FString &string)
static int32	EstimateAffix (bool isNegative, const FDecimalNumberFormattingRules &rules, bool alwaysSign, const FString &negative, const FString &positive)

Detailed Description

Formatter for outputting full decimal numbers. Allows leading signs and group separators.

Constructor & Destructor Documentation

UDecimalFullFormatter()

DBN_FORCEINLINE UDecimalFullFormatter::UDecimalFullFormatter ( )

Flavor:Constructor

Creates a new UDecimalFullFormatter

Implements Opcode:

Flavor:Constructor FF ← ff 0

Member Function Documentation

AppendFullToString()

DBN_FORCEINLINE void UDecimalFullFormatter::AppendFullToString ( const FBigInteger &  number, FString &  string  )

staticFlavor:Static

Formats the number, appending it to the provided string

Parameters

number	The value to be formatted
string	The string that the value should be formatted into

Implements Opcode:

Flavor:Instance 0 ← str BF BI S&

Note

Uses the default formatter

Implements Opcode:

Flavor:Static 0 ← strd BI S&

GetAlwaysSign()

DBN_FORCEINLINE bool UDecimalFullFormatter::GetAlwaysSign ( ) const

Flavor:Instance

Gets whether formatted numbers are always signed

Returns

true if formatted numbers are always signed, otherwise false

Implements Opcode:

Flavor:Instance B ← gosgn FF

GetDefault()

DBN_FORCEINLINE UDecimalFullFormatter * UDecimalFullFormatter::GetDefault ( )

staticFlavor:Static

Gets the default instance of this type of formatter

Returns

the default instance of this type of formatter

Implements Opcode:

Flavor:Static FF ← fmtf 0

GetUseGrouping()

DBN_FORCEINLINE bool UDecimalFullFormatter::GetUseGrouping ( ) const

Flavor:Instance

Gets whether digit grouping is applied to formatting

Returns

true if digit grouping is applied to formatting, otherwise false

Implements Opcode:

Flavor:Instance B ← gogrp FF

OnAppendToString()

virtual void UDecimalFullFormatter::OnAppendToString ( const FBigInteger &  number, FString &  string  ) const

overridevirtualFlavor:Instance

Formats the number, appending it to the provided string

Parameters

number	The value to be formatted
string	The string that the value should be formatted into

Implements Opcode:

Flavor:Instance 0 ← str BF BI S&

Implements Opcode:

Flavor:Instance 0 ← str FF BI S&

Reimplemented from UBigIntegerFormatter.

SetAlwaysSign()

DBN_FORCEINLINE void UDecimalFullFormatter::SetAlwaysSign ( bool  value )

Flavor:Instance

Sets whether formatted numbers are always signed

Parameters

value

true if formatted numbers should always be signed, otherwise false

Implements Opcode:

Flavor:Instance 0 ← sosgn FF B

SetUseGrouping()

DBN_FORCEINLINE void UDecimalFullFormatter::SetUseGrouping ( bool  value )

Flavor:Instance

Sets whether digit grouping is applied to formatting

Parameters

value

true if digit grouping should applied to formatting, otherwise false

Implements Opcode:

Flavor:Instance 0 ← sogrp FF B

ToFullString()

DBN_FORCEINLINE FString UDecimalFullFormatter::ToFullString ( const FBigInteger &  number )

staticFlavor:Static

Formats the number into a new string in culture-aware Decimal Notation

Parameters

number

The value to be formatted

Returns

A new string containing the formatted value

Note

Uses the default formatter

Implements Opcode:

Flavor:Static S ← strd BI

---

The documentation for this class was generated from the following files:

• DecimalFullFormatter.h
• DecimalFullFormatter.inl