ICU 69.1  69.1
Public Member Functions | Friends
icu::number::FormattedNumber Class Reference

The result of a number formatting operation. More...

#include <numberformatter.h>

Inheritance diagram for icu::number::FormattedNumber:
icu::UMemory icu::FormattedValue

Public Member Functions

 FormattedNumber ()
 Default constructor; makes an empty FormattedNumber. More...
 
 FormattedNumber (FormattedNumber &&src) U_NOEXCEPT
 Move constructor: Leaves the source FormattedNumber in an undefined state. More...
 
virtual ~FormattedNumber () U_OVERRIDE
 Destruct an instance of FormattedNumber. More...
 
 FormattedNumber (const FormattedNumber &)=delete
 Copying not supported; use move constructor instead.
 
FormattedNumberoperator= (const FormattedNumber &)=delete
 Copying not supported; use move assignment instead.
 
FormattedNumberoperator= (FormattedNumber &&src) U_NOEXCEPT
 Move assignment: Leaves the source FormattedNumber in an undefined state. More...
 
UnicodeString toString (UErrorCode &status) const U_OVERRIDE
 Returns the formatted string as a self-contained UnicodeString. More...
 
UnicodeString toTempString (UErrorCode &status) const U_OVERRIDE
 Returns the formatted string as a read-only alias to memory owned by the FormattedValue. More...
 
AppendableappendTo (Appendable &appendable, UErrorCode &status) const U_OVERRIDE
 Appends the formatted string to an Appendable. More...
 
UBool nextPosition (ConstrainedFieldPosition &cfpos, UErrorCode &status) const U_OVERRIDE
 Iterates over field positions in the FormattedValue. More...
 
template<typename StringClass >
StringClass toDecimalNumber (UErrorCode &status) const
 Export the formatted number as a "numeric string" conforming to the syntax defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal. More...
 
MeasureUnit getOutputUnit (UErrorCode &status) const
 Gets the resolved output unit. More...
 
const char * getGender (UErrorCode &status) const
 Gets the gender of the formatted output. More...
 
void getDecimalQuantity (impl::DecimalQuantity &output, UErrorCode &status) const
 Gets the raw DecimalQuantity for plural rule selection. More...
 
void getAllFieldPositionsImpl (FieldPositionIteratorHandler &fpih, UErrorCode &status) const
 Populates the mutable builder type FieldPositionIteratorHandler. More...
 
- Public Member Functions inherited from icu::FormattedValue
virtual ~FormattedValue ()
 

Friends

class LocalizedNumberFormatter
 
struct impl::UFormattedNumberImpl
 

Detailed Description

The result of a number formatting operation.

This class allows the result to be exported in several data types, including a UnicodeString and a FieldPositionIterator.

Instances of this class are immutable and thread-safe.

Stable:
ICU 60

Definition at line 2635 of file numberformatter.h.

Constructor & Destructor Documentation

◆ FormattedNumber() [1/2]

icu::number::FormattedNumber::FormattedNumber ( )
inline

Default constructor; makes an empty FormattedNumber.

Stable:
ICU 64

Definition at line 2642 of file numberformatter.h.

◆ FormattedNumber() [2/2]

icu::number::FormattedNumber::FormattedNumber ( FormattedNumber &&  src)

Move constructor: Leaves the source FormattedNumber in an undefined state.

Stable:
ICU 62

◆ ~FormattedNumber()

virtual icu::number::FormattedNumber::~FormattedNumber ( )
virtual

Destruct an instance of FormattedNumber.

Stable:
ICU 60

Member Function Documentation

◆ appendTo()

Appendable& icu::number::FormattedNumber::appendTo ( Appendable appendable,
UErrorCode status 
) const
virtual

Appends the formatted string to an Appendable.

For more information, see FormattedValue::appendTo()

Stable:
ICU 62

Implements icu::FormattedValue.

◆ getAllFieldPositionsImpl()

void icu::number::FormattedNumber::getAllFieldPositionsImpl ( FieldPositionIteratorHandler &  fpih,
UErrorCode status 
) const

Populates the mutable builder type FieldPositionIteratorHandler.

Internal:
Do not use. This API is for internal use only.

◆ getDecimalQuantity()

void icu::number::FormattedNumber::getDecimalQuantity ( impl::DecimalQuantity &  output,
UErrorCode status 
) const

Gets the raw DecimalQuantity for plural rule selection.

Internal:
Do not use. This API is for internal use only.

◆ getGender()

const char* icu::number::FormattedNumber::getGender ( UErrorCode status) const

Gets the gender of the formatted output.

Returns "" when the gender is unknown, or for ungendered languages.

Internal:
Do not use. This API is for internal use only. ICU 69 technology preview.

◆ getOutputUnit()

MeasureUnit icu::number::FormattedNumber::getOutputUnit ( UErrorCode status) const

Gets the resolved output unit.

The output unit is dependent upon the localized preferences for the usage specified via NumberFormatterSettings::usage(), and may be a unit with UMEASURE_UNIT_MIXED unit complexity (MeasureUnit::getComplexity()), such as "foot-and-inch" or "hour-and-minute-and-second".

Returns
MeasureUnit.
Draft:
This API may be changed in the future versions and was introduced in ICU 68

◆ nextPosition()

UBool icu::number::FormattedNumber::nextPosition ( ConstrainedFieldPosition cfpos,
UErrorCode status 
) const
virtual

Iterates over field positions in the FormattedValue.

This lets you determine the position of specific types of substrings, like a month or a decimal separator.

To loop over all field positions:

ConstrainedFieldPosition cfpos;
while (fmtval.nextPosition(cfpos, status)) {
    // handle the field position; get information from cfpos
}
Parameters
cfposThe object used for iteration state. This can provide constraints to iterate over only one specific category or field; see ConstrainedFieldPosition::constrainCategory and ConstrainedFieldPosition::constrainField.
statusSet if an error occurs.
Returns
true if a new occurrence of the field was found; false otherwise or if an error was set.
Stable:
ICU 64

Implements icu::FormattedValue.

◆ operator=()

FormattedNumber& icu::number::FormattedNumber::operator= ( FormattedNumber &&  src)

Move assignment: Leaves the source FormattedNumber in an undefined state.

Stable:
ICU 62

◆ toDecimalNumber()

template<typename StringClass >
StringClass icu::number::FormattedNumber::toDecimalNumber ( UErrorCode status) const
inline

Export the formatted number as a "numeric string" conforming to the syntax defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal.

This endpoint is useful for obtaining the exact number being printed after scaling and rounding have been applied by the number formatter.

Example call site:

auto decimalNumber = fn.toDecimalNumber<std::string>(status);
Template Parameters
StringClassA string class compatible with StringByteSink; for example, std::string.
Parameters
statusSet if an error occurs.
Returns
A StringClass containing the numeric string.
Stable:
ICU 65

Definition at line 2784 of file numberformatter.h.

◆ toString()

UnicodeString icu::number::FormattedNumber::toString ( UErrorCode status) const
virtual

Returns the formatted string as a self-contained UnicodeString.

For more information, see FormattedValue::toString()

Stable:
ICU 62

Implements icu::FormattedValue.

◆ toTempString()

UnicodeString icu::number::FormattedNumber::toTempString ( UErrorCode status) const
virtual

Returns the formatted string as a read-only alias to memory owned by the FormattedValue.

The return value is valid only as long as this FormattedValue is present and unchanged in memory. If you need the string outside the current scope, consider toString.

The buffer returned by calling UnicodeString::getBuffer() on the return value is guaranteed to be NUL-terminated.

Parameters
statusSet if an error occurs.
Returns
a temporary UnicodeString containing the formatted string.
Stable:
ICU 64

Implements icu::FormattedValue.


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