ICU 63.1
63.1
|
The result of a number range formatting operation. More...
#include <numberrangeformatter.h>
Public Member Functions | |
UnicodeString | toString (UErrorCode &status) const |
Returns a UnicodeString representation of the formatted number range. More... | |
Appendable & | appendTo (Appendable &appendable, UErrorCode &status) const |
Appends the formatted number range to an Appendable. More... | |
UBool | nextFieldPosition (FieldPosition &fieldPosition, UErrorCode &status) const |
Determines the start (inclusive) and end (exclusive) indices of the next occurrence of the given field in the output string. More... | |
void | getAllFieldPositions (FieldPositionIterator &iterator, UErrorCode &status) const |
Export the formatted number range to a FieldPositionIterator. More... | |
UnicodeString | getFirstDecimal (UErrorCode &status) const |
Export the first formatted number as a decimal number. More... | |
UnicodeString | getSecondDecimal (UErrorCode &status) const |
Export the second formatted number as a decimal number. More... | |
UNumberRangeIdentityResult | getIdentityResult (UErrorCode &status) const |
Returns whether the pair of numbers was successfully formatted as a range or whether an identity fallback was used. More... | |
FormattedNumberRange (const FormattedNumberRange &)=delete | |
Copying not supported; use move constructor instead. | |
FormattedNumberRange & | operator= (const FormattedNumberRange &)=delete |
Copying not supported; use move assignment instead. | |
FormattedNumberRange (FormattedNumberRange &&src) U_NOEXCEPT | |
Move constructor: Leaves the source FormattedNumberRange in an undefined state. More... | |
FormattedNumberRange & | operator= (FormattedNumberRange &&src) U_NOEXCEPT |
Move assignment: Leaves the source FormattedNumberRange in an undefined state. More... | |
~FormattedNumberRange () | |
Destruct an instance of FormattedNumberRange, cleaning up any memory it might own. More... | |
Friends | |
class | LocalizedNumberRangeFormatter |
The result of a number range formatting operation.
This class allows the result to be exported in several data types, including a UnicodeString and a FieldPositionIterator.
Definition at line 659 of file numberrangeformatter.h.
icu::number::FormattedNumberRange::FormattedNumberRange | ( | FormattedNumberRange && | src | ) |
Move constructor: Leaves the source FormattedNumberRange in an undefined state.
icu::number::FormattedNumberRange::~FormattedNumberRange | ( | ) |
Destruct an instance of FormattedNumberRange, cleaning up any memory it might own.
Appendable& icu::number::FormattedNumberRange::appendTo | ( | Appendable & | appendable, |
UErrorCode & | status | ||
) | const |
Appends the formatted number range to an Appendable.
appendable | The Appendable to which to append the formatted number range string. |
status | Set if an error occurs while formatting the number range to the Appendable. |
void icu::number::FormattedNumberRange::getAllFieldPositions | ( | FieldPositionIterator & | iterator, |
UErrorCode & | status | ||
) | const |
Export the formatted number range to a FieldPositionIterator.
This allows you to determine which characters in the output string correspond to which fields, such as the integer part, fraction part, and sign.
If information on only one field is needed, use nextFieldPosition() instead.
iterator | The FieldPositionIterator to populate with all of the fields present in the formatted number. |
status | Set if an error occurs while populating the FieldPositionIterator. |
UnicodeString icu::number::FormattedNumberRange::getFirstDecimal | ( | UErrorCode & | status | ) | const |
Export the first formatted number as a decimal number.
This endpoint is useful for obtaining the exact number being printed after scaling and rounding have been applied by the number range formatting pipeline.
The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal
UNumberRangeIdentityResult icu::number::FormattedNumberRange::getIdentityResult | ( | UErrorCode & | status | ) | const |
Returns whether the pair of numbers was successfully formatted as a range or whether an identity fallback was used.
For example, if the first and second number were the same either before or after rounding occurred, an identity fallback was used.
UnicodeString icu::number::FormattedNumberRange::getSecondDecimal | ( | UErrorCode & | status | ) | const |
Export the second formatted number as a decimal number.
This endpoint is useful for obtaining the exact number being printed after scaling and rounding have been applied by the number range formatting pipeline.
The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal
UBool icu::number::FormattedNumberRange::nextFieldPosition | ( | FieldPosition & | fieldPosition, |
UErrorCode & | status | ||
) | const |
Determines the start (inclusive) and end (exclusive) indices of the next occurrence of the given field in the output string.
This allows you to determine the locations of, for example, the integer part, fraction part, or symbols.
If both sides of the range have the same field, the field will occur twice, once before the range separator and once after the range separator, if applicable.
If a field occurs just once, calling this method will find that occurrence and return it. If a field occurs multiple times, this method may be called repeatedly with the following pattern:
FieldPosition fpos(UNUM_INTEGER_FIELD); while (formattedNumberRange.nextFieldPosition(fpos, status)) { // do something with fpos. }
This method is useful if you know which field to query. If you want all available field position information, use getAllFieldPositions().
fieldPosition | Input+output variable. See FormattedNumber#nextFieldPosition. |
status | Set if an error occurs while populating the FieldPosition. |
FormattedNumberRange& icu::number::FormattedNumberRange::operator= | ( | FormattedNumberRange && | src | ) |
Move assignment: Leaves the source FormattedNumberRange in an undefined state.
UnicodeString icu::number::FormattedNumberRange::toString | ( | UErrorCode & | status | ) | const |
Returns a UnicodeString representation of the formatted number range.
status | Set if an error occurs while formatting the number to the UnicodeString. |