ICU 59.1  59.1
Public Member Functions | Static Public Member Functions | Protected Member Functions
icu::MeasureFormat Class Reference

A formatter for measure objects. More...

#include <measfmt.h>

Inheritance diagram for icu::MeasureFormat:
icu::Format icu::UObject icu::UMemory icu::TimeUnitFormat

Public Member Functions

 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...
 
MeasureFormatoperator= (const MeasureFormat &rhs)
 Assignment operator. More...
 
virtual ~MeasureFormat ()
 Destructor. More...
 
virtual UBool operator== (const Format &other) const
 Return true if given Format objects are semantically equal. More...
 
virtual Formatclone () const
 Clones this object polymorphically. More...
 
virtual UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
 Formats object to produce a string. More...
 
virtual void parseObject (const UnicodeString &source, Formattable &reslt, ParsePosition &pos) const
 Parse a string to produce an object. More...
 
UnicodeStringformatMeasures (const Measure *measures, int32_t measureCount, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
 Formats measure objects to produce a string. More...
 
UnicodeStringformatMeasurePerUnit (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 (void) const
 Returns a unique class ID POLYMORPHICALLY. More...
 
- Public Member Functions inherited from icu::Format
virtual ~Format ()
 Destructor. More...
 
UBool operator!= (const Format &other) const
 Return true if the given Format objects are not semantically equal. More...
 
UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
 Formats an object to produce a string. More...
 
virtual UnicodeStringformat (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...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static MeasureFormatcreateCurrencyFormat (const Locale &locale, UErrorCode &ec)
 Return a formatter for CurrencyAmount objects in the given locale. More...
 
static MeasureFormatcreateCurrencyFormat (UErrorCode &ec)
 Return a formatter for CurrencyAmount objects in the default locale. More...
 
static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 

Protected Member Functions

 MeasureFormat ()
 Default constructor. More...
 
void initMeasureFormat (const Locale &locale, UMeasureFormatWidth width, NumberFormat *nfToAdopt, UErrorCode &status)
 ICU use only. More...
 
UBool setMeasureFormatLocale (const Locale &locale, UErrorCode &status)
 ICU use only. More...
 
void adoptNumberFormat (NumberFormat *nfToAdopt, UErrorCode &status)
 ICU use only. More...
 
const NumberFormatgetNumberFormat () const
 ICU use only. More...
 
const PluralRulesgetPluralRules () const
 ICU use only. More...
 
Locale getLocale (UErrorCode &status) const
 ICU use only. More...
 
const char * getLocaleID (UErrorCode &status) const
 ICU use only. More...
 
- Protected Member Functions inherited from icu::Format
void setLocaleIDs (const char *valid, const char *actual)
 
 Format ()
 Default constructor for subclass use only. More...
 
 Format (const Format &)
 
Formatoperator= (const Format &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from icu::Format
static void syntaxError (const UnicodeString &pattern, int32_t pos, UParseError &parseError)
 Simple function for initializing a UParseError from a UnicodeString. More...
 

Detailed Description

A formatter for measure objects.

See also
Format
Author
Alan Liu
Stable:
ICU 3.0

Definition at line 97 of file measfmt.h.

Constructor & Destructor Documentation

§ MeasureFormat() [1/4]

icu::MeasureFormat::MeasureFormat ( const Locale locale,
UMeasureFormatWidth  width,
UErrorCode status 
)

Constructor.

Stable:
ICU 53

§ MeasureFormat() [2/4]

icu::MeasureFormat::MeasureFormat ( const Locale locale,
UMeasureFormatWidth  width,
NumberFormat nfToAdopt,
UErrorCode status 
)

Constructor.

Stable:
ICU 53

§ MeasureFormat() [3/4]

icu::MeasureFormat::MeasureFormat ( const MeasureFormat other)

Copy constructor.

Stable:
ICU 3.0

§ ~MeasureFormat()

virtual icu::MeasureFormat::~MeasureFormat ( )
virtual

Destructor.

Stable:
ICU 3.0

§ MeasureFormat() [4/4]

icu::MeasureFormat::MeasureFormat ( )
protected

Default constructor.

Stable:
ICU 3.0

Member Function Documentation

§ adoptNumberFormat()

void icu::MeasureFormat::adoptNumberFormat ( NumberFormat nfToAdopt,
UErrorCode status 
)
protected

ICU use only.

Let subclass change NumberFormat.

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

§ clone()

virtual Format* icu::MeasureFormat::clone ( ) const
virtual

Clones this object polymorphically.

Stable:
ICU 53

Implements icu::Format.

Reimplemented in icu::TimeUnitFormat.

§ createCurrencyFormat() [1/2]

static MeasureFormat* icu::MeasureFormat::createCurrencyFormat ( const Locale locale,
UErrorCode ec 
)
static

Return a formatter for CurrencyAmount objects in the given locale.

Parameters
localedesired locale
ecinput-output error code
Returns
a formatter object, or NULL upon error
Stable:
ICU 3.0

§ createCurrencyFormat() [2/2]

static MeasureFormat* icu::MeasureFormat::createCurrencyFormat ( UErrorCode ec)
static

Return a formatter for CurrencyAmount objects in the default locale.

Parameters
ecinput-output error code
Returns
a formatter object, or NULL upon error
Stable:
ICU 3.0

§ format()

virtual UnicodeString& icu::MeasureFormat::format ( const Formattable obj,
UnicodeString appendTo,
FieldPosition pos,
UErrorCode status 
) const
virtual

Formats object to produce a string.

Stable:
ICU 53

Implements icu::Format.

§ formatMeasurePerUnit()

UnicodeString& icu::MeasureFormat::formatMeasurePerUnit ( const Measure measure,
const MeasureUnit perUnit,
UnicodeString appendTo,
FieldPosition pos,
UErrorCode status 
) const

Formats a single measure per unit.

An example of such a formatted string is 3.5 meters per second.

Parameters
measureThe measure object. In above example, 3.5 meters.
perUnitThe per unit. In above example, it is *MeasureUnit::createSecond(status).
appendToformatted string appended here.
posthe field position.
statusthe error.
Returns
appendTo reference
Stable:
ICU 55

§ formatMeasures()

UnicodeString& icu::MeasureFormat::formatMeasures ( const Measure measures,
int32_t  measureCount,
UnicodeString appendTo,
FieldPosition pos,
UErrorCode status 
) const

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
measuresarray of measure objects.
measureCountthe number of measure objects.
appendToformatted string appended here.
posthe field position.
statusthe error.
Returns
appendTo reference
Stable:
ICU 53

§ getDynamicClassID()

virtual UClassID icu::MeasureFormat::getDynamicClassID ( void  ) const
virtual

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

Locale icu::MeasureFormat::getLocale ( UErrorCode status) const
protected

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

§ getNumberFormat()

const NumberFormat& icu::MeasureFormat::getNumberFormat ( ) 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 ( void  )
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()

UnicodeString icu::MeasureFormat::getUnitDisplayName ( const MeasureUnit unit,
UErrorCode status 
) const

Gets the display name of the specified MeasureUnit corresponding to the current locale and format width.

Parameters
unitThe unit for which to get a display name.
statusthe error.
Returns
The display name in the locale and width specified in MeasureFormat#getInstance, or null if there is no display name available for the specified unit.
Draft:
This API may be changed in the future versions and was introduced in ICU 58

§ initMeasureFormat()

void icu::MeasureFormat::initMeasureFormat ( const Locale locale,
UMeasureFormatWidth  width,
NumberFormat nfToAdopt,
UErrorCode status 
)
protected

ICU use only.

Initialize or change MeasureFormat class from subclass.

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

§ operator=()

MeasureFormat& icu::MeasureFormat::operator= ( const MeasureFormat rhs)

Assignment operator.

Stable:
ICU 3.0

§ operator==()

virtual UBool icu::MeasureFormat::operator== ( const Format other) const
virtual

Return true if given Format objects are semantically equal.

Stable:
ICU 53

Implements icu::Format.

Referenced by icu::TimeUnitFormat::operator!=().

§ parseObject()

virtual void icu::MeasureFormat::parseObject ( const UnicodeString source,
Formattable reslt,
ParsePosition pos 
) const
virtual

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.

§ setMeasureFormatLocale()

UBool icu::MeasureFormat::setMeasureFormatLocale ( const Locale locale,
UErrorCode status 
)
protected

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: