icu::TimeUnit Class Reference

Measurement unit for time units. More...

#include <tmunit.h>

Inheritance diagram for icu::TimeUnit:

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 UObject *	clone () const
	Override clone. More...
	TimeUnit (const TimeUnit &other)
	Copy operator. More...
TimeUnit &	operator= (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...
MeasureUnit &	operator= (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 TimeUnit *	createInstance (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 StringEnumeration *	getAvailableTypes (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 MeasureUnit *	createGForce (UErrorCode &status)
	Creates a unit of acceleration: g-force. More...
static MeasureUnit *	createArcMinute (UErrorCode &status)
	Creates a unit of angle: arc-minute. More...
static MeasureUnit *	createArcSecond (UErrorCode &status)
	Creates a unit of angle: arc-second. More...
static MeasureUnit *	createDegree (UErrorCode &status)
	Creates a unit of angle: degree. More...
static MeasureUnit *	createAcre (UErrorCode &status)
	Creates a unit of area: acre. More...
static MeasureUnit *	createHectare (UErrorCode &status)
	Creates a unit of area: hectare. More...
static MeasureUnit *	createSquareFoot (UErrorCode &status)
	Creates a unit of area: square-foot. More...
static MeasureUnit *	createSquareKilometer (UErrorCode &status)
	Creates a unit of area: square-kilometer. More...
static MeasureUnit *	createSquareMeter (UErrorCode &status)
	Creates a unit of area: square-meter. More...
static MeasureUnit *	createSquareMile (UErrorCode &status)
	Creates a unit of area: square-mile. More...
static MeasureUnit *	createDay (UErrorCode &status)
	Creates a unit of duration: day. More...
static MeasureUnit *	createHour (UErrorCode &status)
	Creates a unit of duration: hour. More...
static MeasureUnit *	createMillisecond (UErrorCode &status)
	Creates a unit of duration: millisecond. More...
static MeasureUnit *	createMinute (UErrorCode &status)
	Creates a unit of duration: minute. More...
static MeasureUnit *	createMonth (UErrorCode &status)
	Creates a unit of duration: month. More...
static MeasureUnit *	createSecond (UErrorCode &status)
	Creates a unit of duration: second. More...
static MeasureUnit *	createWeek (UErrorCode &status)
	Creates a unit of duration: week. More...
static MeasureUnit *	createYear (UErrorCode &status)
	Creates a unit of duration: year. More...
static MeasureUnit *	createCentimeter (UErrorCode &status)
	Creates a unit of length: centimeter. More...
static MeasureUnit *	createFoot (UErrorCode &status)
	Creates a unit of length: foot. More...
static MeasureUnit *	createInch (UErrorCode &status)
	Creates a unit of length: inch. More...
static MeasureUnit *	createKilometer (UErrorCode &status)
	Creates a unit of length: kilometer. More...
static MeasureUnit *	createLightYear (UErrorCode &status)
	Creates a unit of length: light-year. More...
static MeasureUnit *	createMeter (UErrorCode &status)
	Creates a unit of length: meter. More...
static MeasureUnit *	createMile (UErrorCode &status)
	Creates a unit of length: mile. More...
static MeasureUnit *	createMillimeter (UErrorCode &status)
	Creates a unit of length: millimeter. More...
static MeasureUnit *	createPicometer (UErrorCode &status)
	Creates a unit of length: picometer. More...
static MeasureUnit *	createYard (UErrorCode &status)
	Creates a unit of length: yard. More...
static MeasureUnit *	createGram (UErrorCode &status)
	Creates a unit of mass: gram. More...
static MeasureUnit *	createKilogram (UErrorCode &status)
	Creates a unit of mass: kilogram. More...
static MeasureUnit *	createOunce (UErrorCode &status)
	Creates a unit of mass: ounce. More...
static MeasureUnit *	createPound (UErrorCode &status)
	Creates a unit of mass: pound. More...
static MeasureUnit *	createHorsepower (UErrorCode &status)
	Creates a unit of power: horsepower. More...
static MeasureUnit *	createKilowatt (UErrorCode &status)
	Creates a unit of power: kilowatt. More...
static MeasureUnit *	createWatt (UErrorCode &status)
	Creates a unit of power: watt. More...
static MeasureUnit *	createHectopascal (UErrorCode &status)
	Creates a unit of pressure: hectopascal. More...
static MeasureUnit *	createInchHg (UErrorCode &status)
	Creates a unit of pressure: inch-hg. More...
static MeasureUnit *	createMillibar (UErrorCode &status)
	Creates a unit of pressure: millibar. More...
static MeasureUnit *	createKilometerPerHour (UErrorCode &status)
	Creates a unit of speed: kilometer-per-hour. More...
static MeasureUnit *	createMeterPerSecond (UErrorCode &status)
	Creates a unit of speed: meter-per-second. More...
static MeasureUnit *	createMilePerHour (UErrorCode &status)
	Creates a unit of speed: mile-per-hour. More...
static MeasureUnit *	createCelsius (UErrorCode &status)
	Creates a unit of temperature: celsius. More...
static MeasureUnit *	createFahrenheit (UErrorCode &status)
	Creates a unit of temperature: fahrenheit. More...
static MeasureUnit *	createCubicKilometer (UErrorCode &status)
	Creates a unit of volume: cubic-kilometer. More...
static MeasureUnit *	createCubicMile (UErrorCode &status)
	Creates a unit of volume: cubic-mile. More...
static MeasureUnit *	createLiter (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

enum icu::TimeUnit::UTimeUnitFields

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

timeUnitField	time unit field based on which the instance is created.
status	input-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:

• tmunit.h