Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1MeasureFormat.html below:
ICU 77.1: icu::MeasureFormat Class Reference
#include <measfmt.h>
MeasureFormat (const Locale &locale, UMeasureFormatWidth width, UErrorCode &status) Constructor. More...
MeasureFormat (const Locale &locale, UMeasureFormatWidth width, NumberFormat *nfToAdopt, UErrorCode &status) Constructor. More...
MeasureFormat (const MeasureFormat &other) Copy constructor. More...
MeasureFormat & operator= (const MeasureFormat &rhs) Assignment operator. More...
virtual ~MeasureFormat () Destructor. More...
virtual bool operator== (const Format &other) const override Return true if given Format objects are semantically equal. More...
virtual MeasureFormat * clone () const override Clones this object polymorphically. More...
virtual UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override Formats object to produce a string. More...
virtual void parseObject (const UnicodeString &source, Formattable &reslt, ParsePosition &pos) const override Parse a string to produce an object. More...
UnicodeString & formatMeasures (const Measure *measures, int32_t measureCount, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const Formats measure objects to produce a string. More...
UnicodeString & formatMeasurePerUnit (const Measure &measure, const MeasureUnit &perUnit, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const Formats a single measure per unit. More...
UnicodeString getUnitDisplayName (const MeasureUnit &unit, UErrorCode &status) const Gets the display name of the specified MeasureUnit corresponding to the current locale and format width. More...
virtual UClassID getDynamicClassID () const override Returns a unique class ID POLYMORPHICALLY. More...
virtual void parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const=0 Parse a string to produce an object. More...
void parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const Parses a string to produce an object. More...
UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const Formats an object to produce a string. More...
virtual UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const=0 Format an object to produce a string. More...
virtual UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const Format an object to produce a string. More...
virtual ~Format () Destructor. More...
bool operator!= (const Format &other) const Return true if the given Format objects are not semantically equal. More...
UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const Formats an object to produce a string. More...
virtual UnicodeString & format (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const Format an object to produce a string. More...
void parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const Parses a string to produce an object. More...
Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const Get the locale for this format object. More...
const char * getLocaleID (ULocDataLocaleType type, UErrorCode &status) const Get the locale for this format object. More...
virtual ~UObject () Destructor. More...
IMPORTANT: New users are strongly encouraged to see if numberformatter.h fits their use case. Although not deprecated, this header is provided for backwards compatibility only, and has much more limited capabilities.
-
See also
-
Format
-
Stable:
-
ICU 3.0
Definition at line 101 of file measfmt.h.
◆ MeasureFormat() [1/4] ◆ MeasureFormat() [2/4] ◆ MeasureFormat() [3/4] icu::MeasureFormat::MeasureFormat ( const MeasureFormat & other ) ◆ ~MeasureFormat() virtual icu::MeasureFormat::~MeasureFormat ( ) virtual ◆ MeasureFormat() [4/4] icu::MeasureFormat::MeasureFormat ( ) protected
Default constructor.
-
Stable:
-
ICU 3.0
◆ adoptNumberFormat()
ICU use only.
Let subclass change NumberFormat.
-
Internal:
-
Do not use. This API is for internal use only..
◆ clone() ◆ createCurrencyFormat() [1/2] ◆ createCurrencyFormat() [2/2] ◆ format() [1/4] ◆ format() [2/4]
Format an object to produce a string.
This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.
-
Parameters
-
obj The object to format. appendTo Output parameter to receive result. Result is appended to existing contents. pos On input: an alignment field, if desired. On output: the offsets of the alignment field. status Output param filled with success/failure status.
-
Returns
-
Reference to 'appendTo' parameter.
-
Stable:
-
ICU 2.0
◆ format() [3/4]
Format an object to produce a string.
Subclasses should override this method. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.
-
Parameters
-
obj The object to format. appendTo Output parameter to receive result. Result is appended to existing contents. posIter On return, can be used to iterate over positions of fields generated by this format call. status Output param filled with success/failure status.
-
Returns
-
Reference to 'appendTo' parameter.
-
Stable:
-
ICU 4.4
◆ format() [4/4]
Formats an object to produce a string.
-
Parameters
-
obj The object to format. appendTo Output parameter to receive result. Result is appended to existing contents. status Output parameter filled in with success or failure status.
-
Returns
-
Reference to 'appendTo' parameter.
-
Stable:
-
ICU 2.0
◆ formatMeasurePerUnit()
Formats a single measure per unit.
An example of such a formatted string is 3.5 meters per second.
-
Parameters
-
measure The measure object. In above example, 3.5 meters. perUnit The per unit. In above example, it is
*MeasureUnit::createSecond(status)
. appendTo formatted string appended here. pos the field position. status the error.
-
Returns
-
appendTo reference
-
Stable:
-
ICU 55
◆ formatMeasures()
Formats measure objects to produce a string.
An example of such a formatted string is 3 meters, 3.5 centimeters. Measure objects appear in the formatted string in the same order they appear in the "measures" array. The NumberFormat of this object is used only to format the amount of the very last measure. The other amounts are formatted with zero decimal places while rounding toward zero.
-
Parameters
-
measures array of measure objects. measureCount the number of measure objects. appendTo formatted string appended here. pos the field position. status the error.
-
Returns
-
appendTo reference
-
Stable:
-
ICU 53
◆ getCurrencyFormatInternal() const NumberFormat& icu::MeasureFormat::getCurrencyFormatInternal ( ) const protected
ICU use only.
Always returns the short form currency formatter.
-
Internal:
-
Do not use. This API is for internal use only..
◆ getDynamicClassID() virtual UClassID icu::MeasureFormat::getDynamicClassID ( ) const overridevirtual
Returns a unique class ID POLYMORPHICALLY.
Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.
-
Returns
-
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.
-
Stable:
-
ICU 53
Reimplemented from icu::UObject.
Reimplemented in icu::TimeUnitFormat.
◆ getLocale()
ICU use only.
-
Internal:
-
Do not use. This API is for internal use only..
◆ getLocaleID() const char* icu::MeasureFormat::getLocaleID ( UErrorCode & status ) const protected
ICU use only.
-
Internal:
-
Do not use. This API is for internal use only..
◆ getNumberFormatInternal() const NumberFormat& icu::MeasureFormat::getNumberFormatInternal ( ) const protected
ICU use only.
-
Internal:
-
Do not use. This API is for internal use only..
◆ getPluralRules() const PluralRules& icu::MeasureFormat::getPluralRules ( ) const protected
ICU use only.
-
Internal:
-
Do not use. This API is for internal use only..
◆ getStaticClassID() static UClassID icu::MeasureFormat::getStaticClassID ( ) static
Return the class ID for this class.
This is useful only for comparing to a return value from getDynamicClassID(). For example:
. Base* polymorphic_pointer = createPolymorphicObject();
. if (polymorphic_pointer->getDynamicClassID() ==
. erived::getStaticClassID()) ...
-
Returns
-
The class ID for all objects of this class.
-
Stable:
-
ICU 53
◆ getUnitDisplayName()
Gets the display name of the specified MeasureUnit corresponding to the current locale and format width.
-
Parameters
-
unit The unit for which to get a display name. status the error.
-
Returns
-
The display name in the locale and width specified in the MeasureFormat constructor, or null if there is no display name available for the specified unit.
-
Stable:
-
ICU 58
◆ initMeasureFormat()
ICU use only.
Initialize or change MeasureFormat class from subclass.
-
Internal:
-
Do not use. This API is for internal use only..
◆ operator=()
Assignment operator.
-
Stable:
-
ICU 3.0
◆ operator==() virtual bool icu::MeasureFormat::operator== ( const Format & other ) const overridevirtual ◆ parseObject() [1/3]
Parse a string to produce an object.
This implementation sets status to U_UNSUPPORTED_ERROR.
-
Draft:
-
This API may be changed in the future versions and was introduced in ICU 53
Implements icu::Format.
Reimplemented in icu::TimeUnitFormat.
◆ parseObject() [2/3] virtual void icu::Format::parseObject
Parse a string to produce an object.
This is a pure virtual method which subclasses must implement. This method allows polymorphic parsing of strings into Formattable objects.
Before calling, set parse_pos.index to the offset you want to start parsing at in the source. After calling, parse_pos.index is the end of the text you parsed. If error occurs, index is unchanged.
When parsing, leading whitespace is discarded (with successful parse), while trailing whitespace is left as is.
Example:
Parsing "_12_xy" (where _ represents a space) for a number, with index == 0 will result in the number 12, with parse_pos.index updated to 3 (just before the second space). Parsing a second time will result in a failing UErrorCode since "xy" is not a number, and leave index at 3.
Subclasses will typically supply specific parse methods that return different types of values. Since methods can't overload on return types, these will typically be named "parse", while this polymorphic method will always be called parseObject. Any parse method that does not take a parse_pos should set status to an error value when no text in the required format is at the start position.
-
Parameters
-
source The string to be parsed into an object. result Formattable to be set to the parse result. If parse fails, return contents are undefined. parse_pos The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged.
-
Stable:
-
ICU 2.0
◆ parseObject() [3/3] void icu::Format::parseObject
Parses a string to produce an object.
This is a convenience method which calls the pure virtual parseObject() method, and returns a failure UErrorCode if the ParsePosition indicates failure.
-
Parameters
-
source The string to be parsed into an object. result Formattable to be set to the parse result. If parse fails, return contents are undefined. status Output param to be filled with success/failure result code.
-
Stable:
-
ICU 2.0
◆ setMeasureFormatLocale()
ICU use only.
Allows subclass to change locale. Note that this method also changes the NumberFormat object. Returns true if locale changed; false if no change was made.
-
Internal:
-
Do not use. This API is for internal use only..
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4