TimeUnitAmount Class Reference

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

#include <tmutamt.h>

Inheritance diagram for TimeUnitAmount:
Measure UObject UMemory

Public Member Functions

 TimeUnitAmount (const Formattable &number, TimeUnit::UTimeUnitFields timeUnitField, UErrorCode &status)
 Construct TimeUnitAmount object with the given number and the given time unit.
 TimeUnitAmount (double amount, TimeUnit::UTimeUnitFields timeUnitField, UErrorCode &status)
 Construct TimeUnitAmount object with the given numeric amount and the given time unit.
 TimeUnitAmount (const TimeUnitAmount &other)
 Copy constructor.
TimeUnitAmountoperator= (const TimeUnitAmount &other)
 Assignment operator.
virtual UObjectclone () const
 Clone.
virtual ~TimeUnitAmount ()
 Destructor.
virtual UBool operator== (const UObject &other) const
 Equality operator.
UBool operator!= (const UObject &other) const
 Not-equality operator.
virtual UClassID getDynamicClassID (void) const
 Returns a unique class ID POLYMORPHICALLY.
const TimeUnitgetTimeUnit () const
 Get the time unit.
TimeUnit::UTimeUnitFields getTimeUnitField () const
 Get the time unit field value.

Static Public Member Functions

static UClassID getStaticClassID (void)
 Return the class ID for this class.

Detailed Description

Express a duration as a time unit and number.

Patterned after Currency.

See also:
TimeUnitAmount
TimeUnitFormat
Stable:
ICU 4.4

Definition at line 31 of file tmutamt.h.


Constructor & Destructor Documentation

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.4
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.4
TimeUnitAmount::TimeUnitAmount ( const TimeUnitAmount other  ) 

Copy constructor.

Stable:
ICU 4.4
virtual TimeUnitAmount::~TimeUnitAmount (  )  [virtual]

Destructor.

Stable:
ICU 4.4

Member Function Documentation

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

Clone.

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

Implements Measure.

virtual UClassID TimeUnitAmount::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 4.4

Implements UObject.

static UClassID 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.4
const TimeUnit& TimeUnitAmount::getTimeUnit (  )  const

Get the time unit.

Returns:
time unit object.
Stable:
ICU 4.4
TimeUnit::UTimeUnitFields TimeUnitAmount::getTimeUnitField (  )  const

Get the time unit field value.

Returns:
time unit field value.
Stable:
ICU 4.4
UBool 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.4

Definition at line 158 of file tmutamt.h.

References operator==().

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

Assignment operator.

Stable:
ICU 4.4

Reimplemented from Measure.

virtual UBool 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.4

Reimplemented from Measure.

Referenced by operator!=().


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sat Jan 23 15:17:45 2010 for ICU 4.3.4 by  doxygen 1.6.1