icu::TimeUnitAmount Class Reference

Express a duration as a time unit and number. More...

`#include <tmutamt.h>`

Inheritance diagram for icu::TimeUnitAmount:

## Public Member Functions

| TimeUnitAmount (const Formattable &number, TimeUnit::UTimeUnitFields timeUnitField, UErrorCode &status)
| Construct TimeUnitAmount object with the given number and the given time unit. More...
| TimeUnitAmount (double amount, TimeUnit::UTimeUnitFields timeUnitField, UErrorCode &status)
| Construct TimeUnitAmount object with the given numeric amount and the given time unit. More...
| TimeUnitAmount (const TimeUnitAmount &other)
| Copy constructor. More...
TimeUnitAmount & | operator= (const TimeUnitAmount &other)
| Assignment operator. More...
virtual TimeUnitAmount * | clone () const override
| Clone. More...
virtual | ~TimeUnitAmount ()
| Destructor. More...
virtual bool | operator== (const UObject &other) const
| Equality operator. More...
bool | operator!= (const UObject &other) const
| Not-equality operator. More...
virtual UClassID | getDynamicClassID (void) const override
| Returns a unique class ID POLYMORPHICALLY. More...
const TimeUnit & | getTimeUnit () const
| Get the time unit. More...
TimeUnit::UTimeUnitFields | getTimeUnitField () const
| Get the time unit field value. More...
Public Member Functions inherited from icu::Measure
| Measure (const Formattable &number, MeasureUnit *adoptedUnit, UErrorCode &ec)
| Construct an object with the given numeric amount and the given unit. More...
| Measure (const Measure &other)
| Copy constructor. More...
Measure & | operator= (const Measure &other)
| Assignment operator. More...
virtual | ~Measure ()
| Destructor. More...
bool | operator== (const UObject &other) const
| Equality operator. More...
bool | operator!= (const UObject &other) const
| Inequality operator. More...
const Formattable & | getNumber () const
| Return a reference to the numeric value of this object. More...
const MeasureUnit & | getUnit () const
| Return a reference to the unit of this object. More...
Public Member Functions inherited from icu::UObject
virtual | ~UObject ()
| Destructor. More...

## Static Public Member Functions

static UClassID | getStaticClassID (void)
| Return the class ID for this class. More...
Static Public Member Functions inherited from icu::Measure
static UClassID | getStaticClassID (void)
| Return the class ID for this class. More...

## Additional Inherited Members

Protected Member Functions inherited from icu::Measure
| Measure ()
| Default constructor. More...

## Detailed Description

Express a duration as a time unit and number.

Patterned after Currency.

See also
  TimeUnitAmount
  TimeUnitFormat

Stable:
  ICU 4.2

Definition at line 37 of file tmutamt.h.

## Constructor & Destructor Documentation

## TimeUnitAmount() [1/3]

icu::TimeUnitAmount::TimeUnitAmount | ( | const Formattable & | number,
|  | TimeUnit::UTimeUnitFields | timeUnitField,
|  | UErrorCode & | status
| ) |  |

Construct TimeUnitAmount object with the given number and the given time unit.

Parameters

  number | a numeric object; number.isNumeric() must be true
  timeUnitField | the time unit field of a time unit
  status | the input-output error code. If the number is not numeric or the timeUnitField is not valid, then this will be set to a failing value: U_ILLEGAL_ARGUMENT_ERROR.

Stable:
  ICU 4.2

## TimeUnitAmount() [2/3]

icu::TimeUnitAmount::TimeUnitAmount | ( | double | amount,
|  | TimeUnit::UTimeUnitFields | timeUnitField,
|  | UErrorCode & | status
| ) |  |

Construct TimeUnitAmount object with the given numeric amount and the given time unit.

Parameters

  amount | a numeric amount.
  timeUnitField | the time unit field on which a time unit amount object will be created.
  status | the input-output error code. If the timeUnitField is not valid, then this will be set to a failing value: U_ILLEGAL_ARGUMENT_ERROR.

Stable:
  ICU 4.2

## TimeUnitAmount() [3/3]

icu::TimeUnitAmount::TimeUnitAmount | ( | const TimeUnitAmount & | other | ) |

Copy constructor.

Stable:
  ICU 4.2

## ~TimeUnitAmount()

virtual icu::TimeUnitAmount::~TimeUnitAmount | ( |  | ) |

virtual

Destructor.

Stable:
  ICU 4.2

## Member Function Documentation

## clone()

virtual TimeUnitAmount* icu::TimeUnitAmount::clone | ( |  | ) | const

override virtual

Clone.

Returns
  a polymorphic clone of this object. The result will have the same class as returned by getDynamicClassID().

Stable:
  ICU 4.2

Reimplemented from icu::Measure.

## getDynamicClassID()

virtual UClassID icu::TimeUnitAmount::getDynamicClassID | ( | void |  | ) | const

override 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 4.2

Reimplemented from icu::Measure.

## getStaticClassID()

static UClassID icu::TimeUnitAmount::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 4.2

## getTimeUnit()

const TimeUnit& icu::TimeUnitAmount::getTimeUnit | ( |  | ) | const

Get the time unit.

Returns
  time unit object.

Stable:
  ICU 4.2

## getTimeUnitField()

TimeUnit::UTimeUnitFields icu::TimeUnitAmount::getTimeUnitField | ( |  | ) | const

Get the time unit field value.

Returns
  time unit field value.

Stable:
  ICU 4.2

## operator!=()

bool icu::TimeUnitAmount::operator!= | ( | const UObject & | other | ) | const

inline

Not-equality operator.

Parameters

  other | the object to compare to.

Returns
  true if this object is not equal to the given object.

Stable:
  ICU 4.2

Definition at line 164 of file tmutamt.h.

References icu::operator==().

## operator=()

TimeUnitAmount& icu::TimeUnitAmount::operator= | ( | const TimeUnitAmount & | other | ) |

Assignment operator.

Stable:
  ICU 4.2

## operator==()

virtual bool icu::TimeUnitAmount::operator== | ( | const UObject & | other | ) | const

virtual

Equality operator.

Parameters

  other | the object to compare to.

Returns
  true if this object is equal to the given object.

Stable:
  ICU 4.2

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

- i18n/unicode/tmutamt.h