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

Measurement unit for time units. More...

#include <tmunit.h>

Inheritance diagram for icu::TimeUnit:
icu::MeasureUnit icu::UObject icu::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 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 icu::MeasureUnit
 MeasureUnit ()
 Default constructor. More...
 
 MeasureUnit (const MeasureUnit &other)
 Copy constructor. More...
 
MeasureUnitoperator= (const MeasureUnit &other)
 Assignment operator. More...
 
virtual ~MeasureUnit ()
 Destructor. More...
 
virtual UBool operator== (const UObject &other) const
 Equality operator. More...
 
UBool operator!= (const UObject &other) const
 Inequality operator. More...
 
const char * getType () const
 Get the type. More...
 
const char * getSubtype () const
 Get the sub type. More...
 
int32_t getIndex () const
 ICU use only. More...
 
- Public Member Functions inherited from icu::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...
 
- Static Public Member Functions inherited from icu::MeasureUnit
static int32_t getAvailable (MeasureUnit *destArray, int32_t destCapacity, UErrorCode &errorCode)
 getAvailable gets all of the available units. More...
 
static int32_t getAvailable (const char *type, MeasureUnit *destArray, int32_t destCapacity, UErrorCode &errorCode)
 getAvailable gets all of the available units for a specific type. More...
 
static StringEnumerationgetAvailableTypes (UErrorCode &errorCode)
 getAvailableTypes gets all of the available types. More...
 
static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 
static int32_t getIndexCount ()
 ICU use only. More...
 
static MeasureUnitcreateGForce (UErrorCode &status)
 Creates a unit of acceleration: g-force. More...
 
static MeasureUnitcreateArcMinute (UErrorCode &status)
 Creates a unit of angle: arc-minute. More...
 
static MeasureUnitcreateArcSecond (UErrorCode &status)
 Creates a unit of angle: arc-second. More...
 
static MeasureUnitcreateDegree (UErrorCode &status)
 Creates a unit of angle: degree. More...
 
static MeasureUnitcreateAcre (UErrorCode &status)
 Creates a unit of area: acre. More...
 
static MeasureUnitcreateHectare (UErrorCode &status)
 Creates a unit of area: hectare. More...
 
static MeasureUnitcreateSquareFoot (UErrorCode &status)
 Creates a unit of area: square-foot. More...
 
static MeasureUnitcreateSquareKilometer (UErrorCode &status)
 Creates a unit of area: square-kilometer. More...
 
static MeasureUnitcreateSquareMeter (UErrorCode &status)
 Creates a unit of area: square-meter. More...
 
static MeasureUnitcreateSquareMile (UErrorCode &status)
 Creates a unit of area: square-mile. More...
 
static MeasureUnitcreateDay (UErrorCode &status)
 Creates a unit of duration: day. More...
 
static MeasureUnitcreateHour (UErrorCode &status)
 Creates a unit of duration: hour. More...
 
static MeasureUnitcreateMillisecond (UErrorCode &status)
 Creates a unit of duration: millisecond. More...
 
static MeasureUnitcreateMinute (UErrorCode &status)
 Creates a unit of duration: minute. More...
 
static MeasureUnitcreateMonth (UErrorCode &status)
 Creates a unit of duration: month. More...
 
static MeasureUnitcreateSecond (UErrorCode &status)
 Creates a unit of duration: second. More...
 
static MeasureUnitcreateWeek (UErrorCode &status)
 Creates a unit of duration: week. More...
 
static MeasureUnitcreateYear (UErrorCode &status)
 Creates a unit of duration: year. More...
 
static MeasureUnitcreateCentimeter (UErrorCode &status)
 Creates a unit of length: centimeter. More...
 
static MeasureUnitcreateFoot (UErrorCode &status)
 Creates a unit of length: foot. More...
 
static MeasureUnitcreateInch (UErrorCode &status)
 Creates a unit of length: inch. More...
 
static MeasureUnitcreateKilometer (UErrorCode &status)
 Creates a unit of length: kilometer. More...
 
static MeasureUnitcreateLightYear (UErrorCode &status)
 Creates a unit of length: light-year. More...
 
static MeasureUnitcreateMeter (UErrorCode &status)
 Creates a unit of length: meter. More...
 
static MeasureUnitcreateMile (UErrorCode &status)
 Creates a unit of length: mile. More...
 
static MeasureUnitcreateMillimeter (UErrorCode &status)
 Creates a unit of length: millimeter. More...
 
static MeasureUnitcreatePicometer (UErrorCode &status)
 Creates a unit of length: picometer. More...
 
static MeasureUnitcreateYard (UErrorCode &status)
 Creates a unit of length: yard. More...
 
static MeasureUnitcreateGram (UErrorCode &status)
 Creates a unit of mass: gram. More...
 
static MeasureUnitcreateKilogram (UErrorCode &status)
 Creates a unit of mass: kilogram. More...
 
static MeasureUnitcreateOunce (UErrorCode &status)
 Creates a unit of mass: ounce. More...
 
static MeasureUnitcreatePound (UErrorCode &status)
 Creates a unit of mass: pound. More...
 
static MeasureUnitcreateHorsepower (UErrorCode &status)
 Creates a unit of power: horsepower. More...
 
static MeasureUnitcreateKilowatt (UErrorCode &status)
 Creates a unit of power: kilowatt. More...
 
static MeasureUnitcreateWatt (UErrorCode &status)
 Creates a unit of power: watt. More...
 
static MeasureUnitcreateHectopascal (UErrorCode &status)
 Creates a unit of pressure: hectopascal. More...
 
static MeasureUnitcreateInchHg (UErrorCode &status)
 Creates a unit of pressure: inch-hg. More...
 
static MeasureUnitcreateMillibar (UErrorCode &status)
 Creates a unit of pressure: millibar. More...
 
static MeasureUnitcreateKilometerPerHour (UErrorCode &status)
 Creates a unit of speed: kilometer-per-hour. More...
 
static MeasureUnitcreateMeterPerSecond (UErrorCode &status)
 Creates a unit of speed: meter-per-second. More...
 
static MeasureUnitcreateMilePerHour (UErrorCode &status)
 Creates a unit of speed: mile-per-hour. More...
 
static MeasureUnitcreateCelsius (UErrorCode &status)
 Creates a unit of temperature: celsius. More...
 
static MeasureUnitcreateFahrenheit (UErrorCode &status)
 Creates a unit of temperature: fahrenheit. More...
 
static MeasureUnitcreateCubicKilometer (UErrorCode &status)
 Creates a unit of volume: cubic-kilometer. More...
 
static MeasureUnitcreateCubicMile (UErrorCode &status)
 Creates a unit of volume: cubic-mile. More...
 
static MeasureUnitcreateLiter (UErrorCode &status)
 Creates a unit of volume: liter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from icu::MeasureUnit
void initTime (const char *timeId)
 For ICU use only. More...
 
void initCurrency (const char *isoCurrency)
 For ICU use only. 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

icu::TimeUnit::TimeUnit ( const TimeUnit other)

Copy operator.

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

Destructor.

Stable:
ICU 4.2

Member Function Documentation

virtual UObject* icu::TimeUnit::clone ( ) const
virtual

Override clone.

Stable:
ICU 4.2

Reimplemented from icu::MeasureUnit.

static TimeUnit* icu::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 icu::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

Reimplemented from icu::MeasureUnit.

static UClassID icu::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 icu::TimeUnit::getTimeUnitField ( ) const

Get time unit field.

Returns
time unit field.
Stable:
ICU 4.2
TimeUnit& icu::TimeUnit::operator= ( const TimeUnit other)

Assignment operator.

Stable:
ICU 4.2

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