"Fossies" - the Fresh Open Source Software Archive

Member "classicu_1_1number_1_1FormattedNumberRange.html" (3 Oct 2019, 43594 Bytes) of package /linux/misc/icu4c-65_1-docs.zip:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the project site itself.

ICU 65.1  65.1
Public Member Functions | Friends
icu::number::FormattedNumberRange Class Reference

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

#include <numberrangeformatter.h>

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

Public Member Functions

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...
 
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.
 
FormattedNumberRangeoperator= (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...
 
FormattedNumberRangeoperator= (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...
 
- Public Member Functions inherited from icu::FormattedValue
virtual ~FormattedValue ()
 

Friends

class LocalizedNumberRangeFormatter
 

Detailed Description

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.

Instances of this class are immutable and thread-safe.

Stable:
ICU 63

Definition at line 700 of file numberrangeformatter.h.

Constructor & Destructor Documentation

◆ FormattedNumberRange()

icu::number::FormattedNumberRange::FormattedNumberRange ( FormattedNumberRange &&  src)

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

Stable:
ICU 63

◆ ~FormattedNumberRange()

icu::number::FormattedNumberRange::~FormattedNumberRange ( )

Destruct an instance of FormattedNumberRange, cleaning up any memory it might own.

Stable:
ICU 63

Member Function Documentation

◆ appendTo()

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

Appends the formatted string to an Appendable.

For more information, see FormattedValue::appendTo()

Stable:
ICU 63

Implements icu::FormattedValue.

◆ getAllFieldPositions()

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.

Parameters
iteratorThe FieldPositionIterator to populate with all of the fields present in the formatted number.
statusSet if an error occurs while populating the FieldPositionIterator.
Draft:
This API may be changed in the future versions and was introduced in ICU 63
See also
UNumberFormatFields

◆ getFirstDecimal()

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

Returns
A decimal representation of the first formatted number.
Draft:
This API may be changed in the future versions and was introduced in ICU 63
See also
NumberRangeFormatter
getSecondDecimal

◆ getIdentityResult()

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.

Returns
An indication the resulting identity situation in the formatted number range.
Stable:
ICU 63
See also
UNumberRangeIdentityFallback

◆ getSecondDecimal()

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

Returns
A decimal representation of the second formatted number.
Draft:
This API may be changed in the future versions and was introduced in ICU 63
See also
NumberRangeFormatter
getFirstDecimal

◆ nextFieldPosition()

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().

Parameters
fieldPositionInput+output variable. See FormattedNumber#nextFieldPosition.
statusSet if an error occurs while populating the FieldPosition.
Returns
TRUE if a new occurrence of the field was found; FALSE otherwise.
Draft:
This API may be changed in the future versions and was introduced in ICU 63
See also
UNumberFormatFields

◆ nextPosition()

UBool icu::number::FormattedNumberRange::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.
Draft:
This API may be changed in the future versions and was introduced in ICU 64

Implements icu::FormattedValue.

◆ operator=()

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

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

Stable:
ICU 63

◆ toString()

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

Returns the formatted string as a self-contained UnicodeString.

For more information, see FormattedValue::toString()

Stable:
ICU 63

Implements icu::FormattedValue.

◆ toTempString()

UnicodeString icu::number::FormattedNumberRange::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.
Draft:
This API may be changed in the future versions and was introduced in ICU 64

Implements icu::FormattedValue.


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