CurrencyAmount Class Reference

A currency together with a numeric amount, such as 200 USD. More...

#include <curramt.h>

Inheritance diagram for CurrencyAmount:

Public Member Functions
	CurrencyAmount (const Formattable &amount, const UChar *isoCode, UErrorCode &ec)
	Construct an object with the given numeric amount and the given ISO currency code.
	CurrencyAmount (double amount, const UChar *isoCode, UErrorCode &ec)
	Construct an object with the given numeric amount and the given ISO currency code.
	CurrencyAmount (const CurrencyAmount &other)
	Copy constructor.
CurrencyAmount &	operator= (const CurrencyAmount &other)
	Assignment operator.
virtual UObject *	clone () const
	Return a polymorphic clone of this object.
virtual	~CurrencyAmount ()
	Destructor.
virtual UClassID	getDynamicClassID () const
	Returns a unique class ID for this object POLYMORPHICALLY.
const CurrencyUnit &	getCurrency () const
	Return the currency unit object of this object.
const UChar *	getISOCurrency () const
	Return the ISO currency code of this object.
Static Public Member Functions
static UClassID U_EXPORT2	getStaticClassID ()
	Returns the class ID for this class.

---

Detailed Description

A currency together with a numeric amount, such as 200 USD.

Author:

Alan Liu

Draft:

This API may be changed in the future versions and was introduced in ICU 3.0

Definition at line 35 of file curramt.h.

---

Constructor & Destructor Documentation

CurrencyAmount::CurrencyAmount (  const Formattable &  amount, const UChar *  isoCode, UErrorCode &  ec )

Construct an object with the given numeric amount and the given ISO currency code. Parameters: amount  a numeric object; amount.isNumeric() must be TRUE isoCode  the 3-letter ISO 4217 currency code; must not be NULL and must have length 3 ec  input-output error code. If the amount or the isoCode is invalid, then this will be set to a failing value. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

CurrencyAmount::CurrencyAmount (  double  amount, const UChar *  isoCode, UErrorCode &  ec )

Construct an object with the given numeric amount and the given ISO currency code. Parameters: amount  the amount of the given currency isoCode  the 3-letter ISO 4217 currency code; must not be NULL and must have length 3 ec  input-output error code. If the isoCode is invalid, then this will be set to a failing value. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

CurrencyAmount::CurrencyAmount (  const CurrencyAmount &  other  )

Copy constructor. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

virtual CurrencyAmount::~CurrencyAmount (   )  [virtual]

Destructor. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

---

Member Function Documentation

virtual UObject* CurrencyAmount::clone (   )  const [virtual]

Return a polymorphic clone of this object. The result will have the same class as returned by getDynamicClassID(). Draft: This API may be changed in the future versions and was introduced in ICU 3.0 Implements Measure.

const CurrencyUnit & CurrencyAmount::getCurrency (   )  const [inline]

Return the currency unit object of this object. Draft: This API may be changed in the future versions and was introduced in ICU 3.0 Definition at line 119 of file curramt.h. References Measure::getUnit(). Referenced by getISOCurrency().

virtual UClassID CurrencyAmount::getDynamicClassID (   )  const [virtual]

Returns a unique class ID for this object POLYMORPHICALLY. This method implements a simple form of RTTI used by ICU. 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. Draft: This API may be changed in the future versions and was introduced in ICU 3.0 Implements UObject.

const UChar * CurrencyAmount::getISOCurrency (   )  const [inline]

Return the ISO currency code of this object. Draft: This API may be changed in the future versions and was introduced in ICU 3.0 Definition at line 123 of file curramt.h. References getCurrency(), and CurrencyUnit::getISOCurrency().

static UClassID U_EXPORT2 CurrencyAmount::getStaticClassID (   )  [static]

Returns the class ID for this class. This is used to compare to the return value of getDynamicClassID(). Returns: The class ID for all objects of this class. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

CurrencyAmount& CurrencyAmount::operator= (  const CurrencyAmount &  other  )

Assignment operator. Draft: This API may be changed in the future versions and was introduced in ICU 3.0

---

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

• curramt.h

---