Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

GregorianCalendar Class Reference

Concrete class which provides the standard calendar used by most of the world. More...

#include <gregocal.h>

Inheritance diagram for GregorianCalendar:

Calendar List of all members.

Public Types

enum  EEras { BC, AD }
 Useful constants for GregorianCalendar and TimeZone. More...


Public Methods

 GregorianCalendar (UErrorCode& success)
 Constructs a default GregorianCalendar using the current time in the default time zone with the default locale. More...

 GregorianCalendar (TimeZone* zoneToAdopt, UErrorCode& success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the default locale. More...

 GregorianCalendar (const TimeZone& zone, UErrorCode& success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the default locale. More...

 GregorianCalendar (const Locale& aLocale, UErrorCode& success)
 Constructs a GregorianCalendar based on the current time in the default time zone with the given locale. More...

 GregorianCalendar (TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the given locale. More...

 GregorianCalendar (const TimeZone& zone, const Locale& aLocale, UErrorCode& success)
 Constructs a GregorianCalendar based on the current time in the given time zone with the given locale. More...

 GregorianCalendar (int32_t year, int32_t month, int32_t date, UErrorCode& success)
 Constructs a GregorianCalendar with the given AD date set in the default time zone with the default locale. More...

 GregorianCalendar (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode& success)
 Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale. More...

 GregorianCalendar (int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode& success)
 Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale. More...

virtual ~GregorianCalendar ()
 Destructor. More...

 GregorianCalendar (const GregorianCalendar& source)
 Copy constructor. More...

GregorianCalendar& operator= (const GregorianCalendar& right)
 Default assignment operator. More...

virtual Calendarclone (void) const
 Create and return a polymorphic copy of this calendar. More...

void setGregorianChange (UDate date, UErrorCode& success)
 Sets the GregorianCalendar change date. More...

UDate getGregorianChange (void) const
 Gets the Gregorian Calendar change date. More...

UBool isLeapYear (int32_t year) const
 Return true if the given year is a leap year. More...

virtual UBool operator== (const Calendar& that) const
 Compares the equality of two GregorianCalendar objects. More...

virtual UBool equivalentTo (const Calendar& other) const
 Calendar override. More...

virtual void add (EDateFields field, int32_t amount, UErrorCode& status)
 (Overrides Calendar) UDate Arithmetic function. More...

virtual void roll (EDateFields field, int32_t amount, UErrorCode& status)
 (Overrides Calendar) Rolls up or down by the given amount in the specified field. More...

virtual int32_t getMinimum (EDateFields field) const
 (Overrides Calendar) Returns minimum value for the given field. More...

virtual int32_t getMaximum (EDateFields field) const
 (Overrides Calendar) Returns maximum value for the given field. More...

virtual int32_t getGreatestMinimum (EDateFields field) const
 (Overrides Calendar) Returns highest minimum value for the given field if varies. More...

virtual int32_t getLeastMaximum (EDateFields field) const
 (Overrides Calendar) Returns lowest maximum value for the given field if varies. More...

int32_t getActualMinimum (EDateFields field) const
 Return the minimum value that this field could have, given the current date. More...

int32_t getActualMaximum (EDateFields field) const
 Return the maximum value that this field could have, given the current date. More...

virtual UBool inDaylightTime (UErrorCode& status) const
 (Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time. More...

virtual UClassID getDynamicClassID (void) const
 Override Calendar Returns a unique class ID POLYMORPHICALLY. More...


Static Public Methods

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


Protected Methods

virtual void computeFields (UErrorCode& status)
 (Overrides Calendar) Converts GMT as milliseconds to time field values. More...

virtual void computeTime (UErrorCode& status)
 (Overrides Calendar) Converts Calendar's time field values to GMT as milliseconds. More...


Private Methods

int32_t internalGetEra () const
 Return the ERA. More...

int32_t monthLength (int32_t month) const
int32_t monthLength (int32_t month, int32_t year) const
int32_t yearLength (int32_t year) const
int32_t yearLength (void) const
void pinDayOfMonth (void)
 After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around. More...

UDate getEpochDay (UErrorCode& status)
 Return the day number with respect to the epoch. More...

int32_t computeRelativeDOW () const
int32_t computeRelativeDOW (double julianDay) const
int32_t computeDOYfromWOY (double julianDayOfYear) const
double computeJulianDay (UBool isGregorian, int32_t year)
 Compute the Julian day number under either the Gregorian or the Julian calendar, using the given year and the remaining fields. More...

void timeToFields (UDate theTime, UBool quick, UErrorCode& status)
 Compute the date-based fields given the milliseconds since the epoch start. More...

int32_t weekNumber (int32_t date, int32_t day)
 Return the week number of a day, within a period. More...

UBool validateFields (void) const
 Validates the values of the set time fields. More...

UBool boundsCheck (int32_t value, EDateFields field) const
 Validates the value of the given time field. More...

int32_t aggregateStamp (int32_t stamp_a, int32_t stamp_b)
 Return the pseudo-time-stamp for two fields, given their individual pseudo-time-stamps. More...


Private Attributes

UDate fGregorianCutover
 The point at which the Gregorian calendar rules are used, measured in milliseconds from the standard epoch. More...

UDate fNormalizedGregorianCutover
 Midnight, local time (using this Calendar's TimeZone) at or before the gregorianCutover. More...

int32_t fGregorianCutoverYear
 The year of the gregorianCutover, with 0 representing 1 BC, -1 representing 2 BC, etc. More...


Static Private Methods

double computeJulianDayOfYear (UBool isGregorian, int32_t year, UBool& isLeap)
double millisToJulianDay (UDate millis)
 Converts time as milliseconds to Julian date. More...

UDate julianDayToMillis (double julian)
 Converts Julian date to time as milliseconds. More...

uint8_t julianDayToDayOfWeek (double julian)
 Convert a quasi Julian date to the day of the week. More...

double floorDivide (double numerator, double denominator)
 Divide two long integers, returning the floor of the quotient. More...

int32_t floorDivide (int32_t numerator, int32_t denominator)
 Divide two integers, returning the floor of the quotient. More...

int32_t floorDivide (int32_t numerator, int32_t denominator, int32_t remainder[])
 Divide two integers, returning the floor of the quotient, and the modulus remainder. More...

int32_t floorDivide (double numerator, int32_t denominator, int32_t remainder[])
 Divide two integers, returning the floor of the quotient, and the modulus remainder. More...


Static Private Attributes

const UDate EARLIEST_SUPPORTED_MILLIS
const UDate LATEST_SUPPORTED_MILLIS
char fgClassID
const UDate kPapalCutover
const int32_t kJan1_1JulianDay
const int32_t kEpochStartAsJulianDay
const int32_t kEpochYear
const int32_t kNumDays []
const int32_t kLeapNumDays []
const int32_t kMonthLength []
const int32_t kLeapMonthLength []
const int32_t kMinValues []
const int32_t kLeastMaxValues []
const int32_t kMaxValues []
const int32_t kOneSecond
const int32_t kOneMinute
const int32_t kOneHour
const double kOneDay
const double kOneWeek

Detailed Description

Concrete class which provides the standard calendar used by most of the world.

The standard (Gregorian) calendar has 2 eras, BC and AD.

This implementation handles a single discontinuity, which corresponds by default to the date the Gregorian calendar was originally instituted (October 15, 1582). Not all countries adopted the Gregorian calendar then, so this cutover date may be changed by the caller.

Prior to the institution of the Gregorian Calendar, New Year's Day was March 25. To avoid confusion, this Calendar always uses January 1. A manual adjustment may be made if desired for dates that are prior to the Gregorian changeover and which fall between January 1 and March 24.

Values calculated for the WEEK_OF_YEAR field range from 1 to 53. Week 1 for a year is the first week that contains at least getMinimalDaysInFirstWeek() days from that year. It thus depends on the values of getMinimalDaysInFirstWeek(), getFirstDayOfWeek(), and the day of the week of January 1. Weeks between week 1 of one year and week 1 of the following year are numbered sequentially from 2 to 52 or 53 (as needed).

For example, January 1, 1998 was a Thursday. If getFirstDayOfWeek() is MONDAY and getMinimalDaysInFirstWeek() is 4 (these are the values reflecting ISO 8601 and many national standards), then week 1 of 1998 starts on December 29, 1997, and ends on January 4, 1998. If, however, getFirstDayOfWeek() is SUNDAY, then week 1 of 1998 starts on January 4, 1998, and ends on January 10, 1998; the first three days of 1998 then are part of week 53 of 1997.

Example for using GregorianCalendar:

 
     // get the supported ids for GMT-08:00 (Pacific Standard Time)
     int32_t idsCount;
     const UnicodeString** ids = TimeZone::createAvailableIDs(-8 * 60 * 60 * 1000, idsCount);
     // if no ids were returned, something is wrong. get out.
     if (idsCount == 0) {
         return;
     }

     // begin output
     cout << "Current Time" << endl;

     // create a Pacific Standard Time time zone
     SimpleTimeZone* pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, *(ids[0]));

     // set up rules for daylight savings time
     pdt->setStartRule(Calendar::APRIL, 1, Calendar::SUNDAY, 2 * 60 * 60 * 1000);
     pdt->setEndRule(Calendar::OCTOBER, -1, Calendar::SUNDAY, 2 * 60 * 60 * 1000);

     // create a GregorianCalendar with the Pacific Daylight time zone
     // and the current date and time
     UErrorCode success = U_ZERO_ERROR;
     Calendar* calendar = new GregorianCalendar( pdt, success );

     // print out a bunch of interesting things
     cout << "ERA: " << calendar->get( Calendar::ERA, success ) << endl;
     cout << "YEAR: " << calendar->get( Calendar::YEAR, success ) << endl;
     cout << "MONTH: " << calendar->get( Calendar::MONTH, success ) << endl;
     cout << "WEEK_OF_YEAR: " << calendar->get( Calendar::WEEK_OF_YEAR, success ) << endl;
     cout << "WEEK_OF_MONTH: " << calendar->get( Calendar::WEEK_OF_MONTH, success ) << endl;
     cout << "DATE: " << calendar->get( Calendar::DATE, success ) << endl;
     cout << "DAY_OF_MONTH: " << calendar->get( Calendar::DAY_OF_MONTH, success ) << endl;
     cout << "DAY_OF_YEAR: " << calendar->get( Calendar::DAY_OF_YEAR, success ) << endl;
     cout << "DAY_OF_WEEK: " << calendar->get( Calendar::DAY_OF_WEEK, success ) << endl;
     cout << "DAY_OF_WEEK_IN_MONTH: " << calendar->get( Calendar::DAY_OF_WEEK_IN_MONTH, success ) << endl;
     cout << "AM_PM: " << calendar->get( Calendar::AM_PM, success ) << endl;
     cout << "HOUR: " << calendar->get( Calendar::HOUR, success ) << endl;
     cout << "HOUR_OF_DAY: " << calendar->get( Calendar::HOUR_OF_DAY, success ) << endl;
     cout << "MINUTE: " << calendar->get( Calendar::MINUTE, success ) << endl;
     cout << "SECOND: " << calendar->get( Calendar::SECOND, success ) << endl;
     cout << "MILLISECOND: " << calendar->get( Calendar::MILLISECOND, success ) << endl;
     cout << "ZONE_OFFSET: " << (calendar->get( Calendar::ZONE_OFFSET, success )/(60*60*1000)) << endl;
     cout << "DST_OFFSET: " << (calendar->get( Calendar::DST_OFFSET, success )/(60*60*1000)) << endl;

     cout << "Current Time, with hour reset to 3" << endl;
     calendar->clear(Calendar::HOUR_OF_DAY); // so doesn't override
     calendar->set(Calendar::HOUR, 3);
     cout << "ERA: " << calendar->get( Calendar::ERA, success ) << endl;
     cout << "YEAR: " << calendar->get( Calendar::YEAR, success ) << endl;
     cout << "MONTH: " << calendar->get( Calendar::MONTH, success ) << endl;
     cout << "WEEK_OF_YEAR: " << calendar->get( Calendar::WEEK_OF_YEAR, success ) << endl;
     cout << "WEEK_OF_MONTH: " << calendar->get( Calendar::WEEK_OF_MONTH, success ) << endl;
     cout << "DATE: " << calendar->get( Calendar::DATE, success ) << endl;
     cout << "DAY_OF_MONTH: " << calendar->get( Calendar::DAY_OF_MONTH, success ) << endl;
     cout << "DAY_OF_YEAR: " << calendar->get( Calendar::DAY_OF_YEAR, success ) << endl;
     cout << "DAY_OF_WEEK: " << calendar->get( Calendar::DAY_OF_WEEK, success ) << endl;
     cout << "DAY_OF_WEEK_IN_MONTH: " << calendar->get( Calendar::DAY_OF_WEEK_IN_MONTH, success ) << endl;
     cout << "AM_PM: " << calendar->get( Calendar::AM_PM, success ) << endl;
     cout << "HOUR: " << calendar->get( Calendar::HOUR, success ) << endl;
     cout << "HOUR_OF_DAY: " << calendar->get( Calendar::HOUR_OF_DAY, success ) << endl;
     cout << "MINUTE: " << calendar->get( Calendar::MINUTE, success ) << endl;
     cout << "SECOND: " << calendar->get( Calendar::SECOND, success ) << endl;
     cout << "MILLISECOND: " << calendar->get( Calendar::MILLISECOND, success ) << endl;
     cout << "ZONE_OFFSET: " << (calendar->get( Calendar::ZONE_OFFSET, success )/(60*60*1000)) << endl; // in hours
     cout << "DST_OFFSET: " << (calendar->get( Calendar::DST_OFFSET, success )/(60*60*1000)) << endl; // in hours

     delete[] ids;
     delete calendar; // also deletes pdt

Definition at line 133 of file gregocal.h.


Member Enumeration Documentation

enum GregorianCalendar::EEras
 

Useful constants for GregorianCalendar and TimeZone.

Enumeration values:
BC  
AD  

Definition at line 139 of file gregocal.h.


Constructor & Destructor Documentation

GregorianCalendar::GregorianCalendar ( UErrorCode & success )
 

Constructs a default GregorianCalendar using the current time in the default time zone with the default locale.

Parameters:
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( TimeZone * zoneToAdopt,
UErrorCode & success )
 

Constructs a GregorianCalendar based on the current time in the given time zone with the default locale.

Clients are no longer responsible for deleting the given time zone object after it's adopted.

Parameters:
zoneToAdopt   The given timezone.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( const TimeZone & zone,
UErrorCode & success )
 

Constructs a GregorianCalendar based on the current time in the given time zone with the default locale.

Parameters:
zone   The given timezone.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( const Locale & aLocale,
UErrorCode & success )
 

Constructs a GregorianCalendar based on the current time in the default time zone with the given locale.

Parameters:
aLocale   The given locale.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( TimeZone * zoneToAdopt,
const Locale & aLocale,
UErrorCode & success )
 

Constructs a GregorianCalendar based on the current time in the given time zone with the given locale.

Clients are no longer responsible for deleting the given time zone object after it's adopted.

Parameters:
zoneToAdopt   The given timezone.
aLocale   The given locale.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( const TimeZone & zone,
const Locale & aLocale,
UErrorCode & success )
 

Constructs a GregorianCalendar based on the current time in the given time zone with the given locale.

Parameters:
zone   The given timezone.
aLocale   The given locale.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( int32_t year,
int32_t month,
int32_t date,
UErrorCode & success )
 

Constructs a GregorianCalendar with the given AD date set in the default time zone with the default locale.

Parameters:
year   The value used to set the YEAR time field in the calendar.
month   The value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
date   The value used to set the DATE time field in the calendar.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( int32_t year,
int32_t month,
int32_t date,
int32_t hour,
int32_t minute,
UErrorCode & success )
 

Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale.

Parameters:
year   The value used to set the YEAR time field in the calendar.
month   The value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
date   The value used to set the DATE time field in the calendar.
hour   The value used to set the HOUR_OF_DAY time field in the calendar.
minute   The value used to set the MINUTE time field in the calendar.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::GregorianCalendar ( int32_t year,
int32_t month,
int32_t date,
int32_t hour,
int32_t minute,
int32_t second,
UErrorCode & success )
 

Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the default locale.

Parameters:
year   The value used to set the YEAR time field in the calendar.
month   The value used to set the MONTH time field in the calendar. Month value is 0-based. e.g., 0 for January.
date   The value used to set the DATE time field in the calendar.
hour   The value used to set the HOUR_OF_DAY time field in the calendar.
minute   The value used to set the MINUTE time field in the calendar.
second   The value used to set the SECOND time field in the calendar.
success   Indicates the status of GregorianCalendar object construction. Returns U_ZERO_ERROR if constructed successfully.
Stable:

GregorianCalendar::~GregorianCalendar ( ) [virtual]
 

Destructor.

Stable:

GregorianCalendar::GregorianCalendar ( const GregorianCalendar & source )
 

Copy constructor.

Stable:


Member Function Documentation

void GregorianCalendar::add ( EDateFields field,
int32_t amount,
UErrorCode & status ) [virtual]
 

(Overrides Calendar) UDate Arithmetic function.

Adds the specified (signed) amount of time to the given time field, based on the calendar's rules. For more information, see the documentation for Calendar::add().

Parameters:
field   The time field.
amount   The amount of date or time to be added to the field.
status   Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::aggregateStamp ( int32_t stamp_a,
int32_t stamp_b ) [private]
 

Return the pseudo-time-stamp for two fields, given their individual pseudo-time-stamps.

If either of the fields is unset, then the aggregate is unset. Otherwise, the aggregate is the later of the two stamps.

UBool GregorianCalendar::boundsCheck ( int32_t value,
EDateFields field ) const [private]
 

Validates the value of the given time field.

True if it's valid.

Calendar * GregorianCalendar::clone ( void ) const [virtual]
 

Create and return a polymorphic copy of this calendar.

Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::computeDOYfromWOY ( double julianDayOfYear ) const [private]
 

void GregorianCalendar::computeFields ( UErrorCode & status ) [protected, virtual]
 

(Overrides Calendar) Converts GMT as milliseconds to time field values.

Stable:

Reimplemented from Calendar.

double GregorianCalendar::computeJulianDay ( UBool isGregorian,
int32_t year ) [private]
 

Compute the Julian day number under either the Gregorian or the Julian calendar, using the given year and the remaining fields.

Parameters:
isGregorian   if true, use the Gregorian calendar
year   the adjusted year number, with 0 indicating the year 1 BC, -1 indicating 2 BC, etc.
Returns:
the Julian day number

double GregorianCalendar::computeJulianDayOfYear ( UBool isGregorian,
int32_t year,
UBool & isLeap ) [static, private]
 

int32_t GregorianCalendar::computeRelativeDOW ( double julianDay ) const [private]
 

int32_t GregorianCalendar::computeRelativeDOW ( ) const [private]
 

void GregorianCalendar::computeTime ( UErrorCode & status ) [protected, virtual]
 

(Overrides Calendar) Converts Calendar's time field values to GMT as milliseconds.

Parameters:
status   Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Stable:

Reimplemented from Calendar.

UBool GregorianCalendar::equivalentTo ( const Calendar & other ) const [virtual]
 

Calendar override.

Return true if another Calendar object is equivalent to this one. An equivalent Calendar will behave exactly as this one does, but may be set to a different time.

Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::floorDivide ( double numerator,
int32_t denominator,
int32_t remainder[] ) [static, private]
 

Divide two integers, returning the floor of the quotient, and the modulus remainder.

Unlike the built-in division, this is mathematically well-behaved. E.g., -1/4 => 0 and -14 => -1, but floorDivide(-1,4) => -1 with remainder[0] => 3.

Parameters:
numerator   the numerator
denominator   a divisor which must be > 0
remainder   an array of at least one element in which the value numerator mod denominator is returned. Unlike numerator % denominator, this will always be non-negative.
Returns:
the floor of the quotient.

int32_t GregorianCalendar::floorDivide ( int32_t numerator,
int32_t denominator,
int32_t remainder[] ) [static, private]
 

Divide two integers, returning the floor of the quotient, and the modulus remainder.

Unlike the built-in division, this is mathematically well-behaved. E.g., -1/4 => 0 and -14 => -1, but floorDivide(-1,4) => -1 with remainder[0] => 3.

Parameters:
numerator   the numerator
denominator   a divisor which must be > 0
remainder   an array of at least one element in which the value numerator mod denominator is returned. Unlike numerator % denominator, this will always be non-negative.
Returns:
the floor of the quotient.

int32_t GregorianCalendar::floorDivide ( int32_t numerator,
int32_t denominator ) [static, private]
 

Divide two integers, returning the floor of the quotient.

Unlike the built-in division, this is mathematically well-behaved. E.g., -1/4 => 0 but floorDivide(-1,4) => -1.

Parameters:
numerator   the numerator
denominator   a divisor which must be > 0
Returns:
the floor of the quotient.

double GregorianCalendar::floorDivide ( double numerator,
double denominator ) [static, private]
 

Divide two long integers, returning the floor of the quotient.

Unlike the built-in division, this is mathematically well-behaved. E.g., -1/4 => 0 but floorDivide(-1,4) => -1.

Parameters:
numerator   the numerator
denominator   a divisor which must be > 0
Returns:
the floor of the quotient.

int32_t GregorianCalendar::getActualMaximum ( EDateFields field ) const
 

Return the maximum value that this field could have, given the current date.

For example, with the date "Feb 3, 1997" and the DAY_OF_MONTH field, the actual maximum would be 28; for "Feb 3, 1996" it s 29. Similarly for a Hebrew calendar, for some years the actual maximum for MONTH is 12, and for others 13.

Stable:

int32_t GregorianCalendar::getActualMinimum ( EDateFields field ) const
 

Return the minimum value that this field could have, given the current date.

For the Gregorian calendar, this is the same as getMinimum() and getGreatestMinimum().

Stable:

UClassID GregorianCalendar::getDynamicClassID ( void ) const [inline, virtual]
 

Override Calendar 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:

Reimplemented from Calendar.

Definition at line 436 of file gregocal.h.

UDate GregorianCalendar::getEpochDay ( UErrorCode & status ) [private]
 

Return the day number with respect to the epoch.

January 1, 1970 (Gregorian) is day zero.

int32_t GregorianCalendar::getGreatestMinimum ( EDateFields field ) const [virtual]
 

(Overrides Calendar) Returns highest minimum value for the given field if varies.

Otherwise same as getMinimum(). For Gregorian, no difference.

Stable:

Reimplemented from Calendar.

UDate GregorianCalendar::getGregorianChange ( void ) const
 

Gets the Gregorian Calendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

Returns:
The Gregorian cutover time for this calendar.
Stable:

int32_t GregorianCalendar::getLeastMaximum ( EDateFields field ) const [virtual]
 

(Overrides Calendar) Returns lowest maximum value for the given field if varies.

Otherwise same as getMaximum(). For Gregorian DAY_OF_MONTH, 28.

Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::getMaximum ( EDateFields field ) const [virtual]
 

(Overrides Calendar) Returns maximum value for the given field.

e.g. for Gregorian DAY_OF_MONTH, 31.

Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::getMinimum ( EDateFields field ) const [virtual]
 

(Overrides Calendar) Returns minimum value for the given field.

e.g. for Gregorian DAY_OF_MONTH, 1.

Stable:

Reimplemented from Calendar.

UClassID GregorianCalendar::getStaticClassID ( void ) [inline, 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() == Derived::getStaticClassID()) ...

Returns:
The class ID for all objects of this class.
Stable:

Definition at line 449 of file gregocal.h.

UBool GregorianCalendar::inDaylightTime ( UErrorCode & status ) const [virtual]
 

(Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time.

Recognizes DST_OFFSET, if it is set.

Parameters:
status   Fill-in parameter which receives the status of this operation.
Returns:
True if the current date for this Calendar is in Daylight Savings Time, false, otherwise.
Stable:

Reimplemented from Calendar.

int32_t GregorianCalendar::internalGetEra ( ) const [private]
 

Return the ERA.

We need a special method for this because the default ERA is AD, but a zero (unset) ERA is BC.

UBool GregorianCalendar::isLeapYear ( int32_t year ) const
 

Return true if the given year is a leap year.

Determination of whether a year is a leap year is actually very complicated. We do something crude and mostly correct here, but for a real determination you need a lot of contextual information. For example, in Sweden, the change from Julian to Gregorian happened in a complex way resulting in missed leap years and double leap years between 1700 and 1753. Another example is that after the start of the Julian calendar in 45 B.C., the leap years did not regularize until 8 A.D. This method ignores these quirks, and pays attention only to the Julian onset date and the Gregorian cutover (which can be changed).

Parameters:
year   The given year.
Returns:
True if the given year is a leap year; false otherwise.
Stable:

uint8_t GregorianCalendar::julianDayToDayOfWeek ( double julian ) [inline, static, private]
 

Convert a quasi Julian date to the day of the week.

The Julian date used here is not a true Julian date, since it is measured from midnight, not noon. Return value is one-based.

Returns:
Day number from 1..7 (SUN..SAT).

Definition at line 701 of file gregocal.h.

UDate GregorianCalendar::julianDayToMillis ( double julian ) [static, private]
 

Converts Julian date to time as milliseconds.

The Julian date used here is not a true Julian date, since it is measured from midnight, not noon.

Parameters:
julian   The given Julian date number.
Returns:
Time as milliseconds.

double GregorianCalendar::millisToJulianDay ( UDate millis ) [static, private]
 

Converts time as milliseconds to Julian date.

The Julian date used here is not a true Julian date, since it is measured from midnight, not noon.

Parameters:
millis   The given milliseconds.
Returns:
The Julian date number.

int32_t GregorianCalendar::monthLength ( int32_t month,
int32_t year ) const [private]
 

int32_t GregorianCalendar::monthLength ( int32_t month ) const [private]
 

GregorianCalendar & GregorianCalendar::operator= ( const GregorianCalendar & right )
 

Default assignment operator.

Stable:

UBool GregorianCalendar::operator== ( const Calendar & that ) const [virtual]
 

Compares the equality of two GregorianCalendar objects.

Objects of different subclasses are considered unequal. This is a strict equality test; see the documentation for Calendar::operator==().

Parameters:
that   The GregorianCalendar object to be compared with.
Returns:
True if the given GregorianCalendar is the same as this GregorianCalendar; false otherwise.
Stable:

Reimplemented from Calendar.

void GregorianCalendar::pinDayOfMonth ( void ) [private]
 

After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around.

E.g., we don't want Jan 31 + 1 month to go to Mar 3, we want it to go to Feb 28. Adjustments which might run into this problem call this method to retain the proper month.

void GregorianCalendar::roll ( EDateFields field,
int32_t amount,
UErrorCode & status ) [virtual]
 

(Overrides Calendar) Rolls up or down by the given amount in the specified field.

For more information, see the documentation for Calendar::roll().

Parameters:
field   The time field.
amount   Indicates amount to roll.
status   Output param set to success/failure code on exit. If any value previously set in the time field is invalid, this will be set to an error status.
Stable:

Reimplemented from Calendar.

void GregorianCalendar::setGregorianChange ( UDate date,
UErrorCode & success )
 

Sets the GregorianCalendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

Parameters:
date   The given Gregorian cutover date.
success   Output param set to success/failure code on exit.
Stable:

void GregorianCalendar::timeToFields ( UDate theTime,
UBool quick,
UErrorCode & status ) [private]
 

Compute the date-based fields given the milliseconds since the epoch start.

Do not compute the time-based fields (HOUR, MINUTE, etc.).

Parameters:
theTime   the time in wall millis (either Standard or DST), whichever is in effect
quick   if true, only compute the ERA, YEAR, MONTH, DATE, DAY_OF_WEEK, and DAY_OF_YEAR.

UBool GregorianCalendar::validateFields ( void ) const [private]
 

Validates the values of the set time fields.

True if they're all valid.

int32_t GregorianCalendar::weekNumber ( int32_t date,
int32_t day ) [private]
 

Return the week number of a day, within a period.

This may be the week number in a year, or the week number in a month. Usually this will be a value >= 1, but if some initial days of the period are excluded from week 1, because minimalDaysInFirstWeek is > 1, then the week number will be zero for those initial days. Requires the day of week for the given date in order to determine the day of week of the first day of the period.

Parameters:
date   Day-of-year or day-of-month. Should be 1 for first day of period.
day   Day-of-week for given dayOfPeriod. 1-based with 1=Sunday.
Returns:
Week number, one-based, or zero if the day falls in part of the month before the first week, when there are days before the first week because the minimum days in the first week is more than one.

int32_t GregorianCalendar::yearLength ( void ) const [private]
 

int32_t GregorianCalendar::yearLength ( int32_t year ) const [private]
 


Member Data Documentation

const UDate GregorianCalendar::EARLIEST_SUPPORTED_MILLIS [static, private]
 

Definition at line 479 of file gregocal.h.

const UDate GregorianCalendar::LATEST_SUPPORTED_MILLIS [static, private]
 

Definition at line 480 of file gregocal.h.

UDate GregorianCalendar::fGregorianCutover [private]
 

The point at which the Gregorian calendar rules are used, measured in milliseconds from the standard epoch.

Default is October 15, 1582 (Gregorian) 00:00:00 UTC, that is, October 4, 1582 (Julian) is followed by October 15, 1582 (Gregorian). This corresponds to Julian day number 2299161.

Definition at line 576 of file gregocal.h.

int32_t GregorianCalendar::fGregorianCutoverYear [private]
 

The year of the gregorianCutover, with 0 representing 1 BC, -1 representing 2 BC, etc.

Definition at line 589 of file gregocal.h.

UDate GregorianCalendar::fNormalizedGregorianCutover [private]
 

Midnight, local time (using this Calendar's TimeZone) at or before the gregorianCutover.

This is a pure date value with no time of day or timezone component.

Definition at line 583 of file gregocal.h.

char GregorianCalendar::fgClassID [static, private]
 

Definition at line 591 of file gregocal.h.

const int32_t GregorianCalendar::kEpochStartAsJulianDay [static, private]
 

Definition at line 680 of file gregocal.h.

const int32_t GregorianCalendar::kEpochYear [static, private]
 

Definition at line 681 of file gregocal.h.

const int32_t GregorianCalendar::kJan1_1JulianDay [static, private]
 

Definition at line 679 of file gregocal.h.

const int32_t GregorianCalendar::kLeapMonthLength[] [static, private]
 

Definition at line 686 of file gregocal.h.

const int32_t GregorianCalendar::kLeapNumDays[] [static, private]
 

Definition at line 684 of file gregocal.h.

const int32_t GregorianCalendar::kLeastMaxValues[] [static, private]
 

Definition at line 689 of file gregocal.h.

const int32_t GregorianCalendar::kMaxValues[] [static, private]
 

Definition at line 690 of file gregocal.h.

const int32_t GregorianCalendar::kMinValues[] [static, private]
 

Definition at line 688 of file gregocal.h.

const int32_t GregorianCalendar::kMonthLength[] [static, private]
 

Definition at line 685 of file gregocal.h.

const int32_t GregorianCalendar::kNumDays[] [static, private]
 

Definition at line 683 of file gregocal.h.

const double GregorianCalendar::kOneDay [static, private]
 

Definition at line 696 of file gregocal.h.

const int32_t GregorianCalendar::kOneHour [static, private]
 

Definition at line 695 of file gregocal.h.

const int32_t GregorianCalendar::kOneMinute [static, private]
 

Definition at line 694 of file gregocal.h.

const int32_t GregorianCalendar::kOneSecond [static, private]
 

Definition at line 693 of file gregocal.h.

const double GregorianCalendar::kOneWeek [static, private]
 

Definition at line 697 of file gregocal.h.

const UDate GregorianCalendar::kPapalCutover [static, private]
 

Definition at line 677 of file gregocal.h.


The documentation for this class was generated from the following file:
Generated at Thu Mar 22 16:13:11 2001 for ICU 1.8 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000