ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions
TimeUnit Class Reference

Measurement unit for time units. More...

#include <tmunit.h>

Inheritance diagram for TimeUnit:
MeasureUnit UObject UMemory

Public Types

enum  UTimeUnitFields {
  UTIMEUNIT_YEAR, UTIMEUNIT_MONTH, UTIMEUNIT_DAY, UTIMEUNIT_WEEK,
  UTIMEUNIT_HOUR, UTIMEUNIT_MINUTE, UTIMEUNIT_SECOND, UTIMEUNIT_FIELD_COUNT
}
 Constants for all the time units we supported. More...
 

Public Member Functions

virtual UObjectclone () const
 Override clone. More...
 
 TimeUnit (const TimeUnit &other)
 Copy operator. More...
 
TimeUnitoperator= (const TimeUnit &other)
 Assignment operator. More...
 
virtual UBool operator== (const UObject &other) const
 Equality operator. More...
 
UBool operator!= (const UObject &other) const
 Non-Equality operator. More...
 
virtual UClassID getDynamicClassID () const
 Returns a unique class ID for this object POLYMORPHICALLY. More...
 
UTimeUnitFields getTimeUnitField () const
 Get time unit field. More...
 
virtual ~TimeUnit ()
 Destructor. More...
 
- Public Member Functions inherited from MeasureUnit
virtual ~MeasureUnit ()
 Destructor. More...
 
- Public Member Functions inherited from UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static TimeUnitcreateInstance (UTimeUnitFields timeUnitField, UErrorCode &status)
 Create Instance. More...
 
static UClassID getStaticClassID ()
 Returns the class ID for this class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MeasureUnit
 MeasureUnit ()
 Default constructor. More...
 

Detailed Description

Measurement unit for time units.

See Also
TimeUnitAmount
TimeUnit
Stable:
ICU 4.2

Definition at line 30 of file tmunit.h.

Member Enumeration Documentation

Constants for all the time units we supported.

Stable:
ICU 4.2

Definition at line 36 of file tmunit.h.

Constructor & Destructor Documentation

TimeUnit::TimeUnit ( const TimeUnit other)

Copy operator.

Stable:
ICU 4.2
virtual TimeUnit::~TimeUnit ( )
virtual

Destructor.

Stable:
ICU 4.2

Member Function Documentation

virtual UObject* TimeUnit::clone ( ) const
virtual

Override clone.

Stable:
ICU 4.2

Implements MeasureUnit.

static TimeUnit* TimeUnit::createInstance ( UTimeUnitFields  timeUnitField,
UErrorCode status 
)
static

Create Instance.

Parameters
timeUnitFieldtime unit field based on which the instance is created.
statusinput-output error code. If the timeUnitField is invalid, then this will be set to U_ILLEGAL_ARGUMENT_ERROR.
Returns
a TimeUnit instance
Stable:
ICU 4.2
virtual UClassID TimeUnit::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.
Stable:
ICU 4.2

Implements UObject.

static UClassID TimeUnit::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.
Stable:
ICU 4.2
UTimeUnitFields TimeUnit::getTimeUnitField ( ) const

Get time unit field.

Returns
time unit field.
Stable:
ICU 4.2
UBool TimeUnit::operator!= ( const UObject other) const
inline

Non-Equality operator.

Returns
true if 2 objects are not the same.
Stable:
ICU 4.2

Definition at line 138 of file tmunit.h.

References operator==().

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

Assignment operator.

Stable:
ICU 4.2
virtual UBool TimeUnit::operator== ( const UObject other) const
virtual

Equality operator.

Returns
true if 2 objects are the same.
Stable:
ICU 4.2

Implements MeasureUnit.

Referenced by operator!=().


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