calendar.h
Go to the documentation of this file.
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
********************************************************************************
* Copyright (C) 1997-2014, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
* File CALENDAR.H
*
* Modification History:
*
* Date Name Description
* 04/22/97 aliu Expanded and corrected comments and other header
* contents.
* 05/01/97 aliu Made equals(), before(), after() arguments const.
* 05/20/97 aliu Replaced fAreFieldsSet with fAreFieldsInSync and
* fAreAllFieldsSet.
* 07/27/98 stephen Sync up with JDK 1.2
* 11/15/99 weiv added YEAR_WOY and DOW_LOCAL
* to EDateFields
* 8/19/2002 srl Removed Javaisms
* 11/07/2003 srl Update, clean up documentation.
********************************************************************************
*/
#ifndef CALENDAR_H
#define CALENDAR_H
#include "unicode/utypes.h"
#if U_SHOW_CPLUSPLUS_API
#if !UCONFIG_NO_FORMATTING
#include "unicode/uobject.h"
#include "unicode/locid.h"
#include "unicode/timezone.h"
#include "unicode/ucal.h"
#include "unicode/umisc.h"
U_NAMESPACE_BEGIN
class ICUServiceFactory;
// Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
// it is a return type for a virtual method (@internal)
typedef int32_t UFieldResolutionTable[12][8];
class BasicTimeZone;
class U_I18N_API Calendar : public UObject {
public:
#ifndef U_FORCE_HIDE_DEPRECATED_API
enum EDateFields {
#ifndef U_HIDE_DEPRECATED_API
/*
* ERA may be defined on other platforms. To avoid any potential problems undefined it here.
*/
#ifdef ERA
#undef ERA
#endif
ERA, // Example: 0..1
YEAR, // Example: 1..big number
MONTH, // Example: 0..11
WEEK_OF_YEAR, // Example: 1..53
WEEK_OF_MONTH, // Example: 1..4
DATE, // Example: 1..31
DAY_OF_YEAR, // Example: 1..365
DAY_OF_WEEK, // Example: 1..7
DAY_OF_WEEK_IN_MONTH, // Example: 1..4, may be specified as -1
AM_PM, // Example: 0..1
HOUR, // Example: 0..11
HOUR_OF_DAY, // Example: 0..23
MINUTE, // Example: 0..59
SECOND, // Example: 0..59
MILLISECOND, // Example: 0..999
ZONE_OFFSET, // Example: -12*U_MILLIS_PER_HOUR..12*U_MILLIS_PER_HOUR
DST_OFFSET, // Example: 0 or U_MILLIS_PER_HOUR
YEAR_WOY, // 'Y' Example: 1..big number - Year of Week of Year
DOW_LOCAL, // 'e' Example: 1..7 - Day of Week / Localized
EXTENDED_YEAR,
JULIAN_DAY,
MILLISECONDS_IN_DAY,
IS_LEAP_MONTH,
FIELD_COUNT = UCAL_FIELD_COUNT // See ucal.h for other fields.
#endif /* U_HIDE_DEPRECATED_API */
};
#endif // U_FORCE_HIDE_DEPRECATED_API
#ifndef U_HIDE_DEPRECATED_API
enum EDaysOfWeek {
SUNDAY = 1,
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY
};
enum EMonths {
JANUARY,
FEBRUARY,
MARCH,
APRIL,
MAY,
JUNE,
JULY,
AUGUST,
SEPTEMBER,
OCTOBER,
NOVEMBER,
DECEMBER,
UNDECIMBER
};
enum EAmpm {
AM,
PM
};
#endif /* U_HIDE_DEPRECATED_API */
virtual ~Calendar();
virtual Calendar* clone() const = 0;
static Calendar* U_EXPORT2 createInstance(UErrorCode& success);
static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, UErrorCode& success);
static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, UErrorCode& success);
static Calendar* U_EXPORT2 createInstance(const Locale& aLocale, UErrorCode& success);
static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success);
static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* key,
const Locale& locale, UBool commonlyUsed, UErrorCode& status);
static UDate U_EXPORT2 getNow(void);
inline UDate getTime(UErrorCode& status) const { return getTimeInMillis(status); }
inline void setTime(UDate date, UErrorCode& status) { setTimeInMillis(date, status); }
virtual bool operator==(const Calendar& that) const;
bool operator!=(const Calendar& that) const {return !operator==(that);}
virtual UBool isEquivalentTo(const Calendar& other) const;
UBool equals(const Calendar& when, UErrorCode& status) const;
UBool before(const Calendar& when, UErrorCode& status) const;
UBool after(const Calendar& when, UErrorCode& status) const;
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual void add(EDateFields field, int32_t amount, UErrorCode& status);
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual void add(UCalendarDateFields field, int32_t amount, UErrorCode& status);
#ifndef U_HIDE_DEPRECATED_API
inline void roll(EDateFields field, UBool up, UErrorCode& status);
#endif /* U_HIDE_DEPRECATED_API */
inline void roll(UCalendarDateFields field, UBool up, UErrorCode& status);
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual int32_t fieldDifference(UDate when, EDateFields field, UErrorCode& status);
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual int32_t fieldDifference(UDate when, UCalendarDateFields field, UErrorCode& status);
void adoptTimeZone(TimeZone* value);
void setTimeZone(const TimeZone& zone);
const TimeZone& getTimeZone(void) const;
TimeZone* orphanTimeZone(void);
virtual UBool inDaylightTime(UErrorCode& status) const;
void setLenient(UBool lenient);
UBool isLenient(void) const;
void setRepeatedWallTimeOption(UCalendarWallTimeOption option);
UCalendarWallTimeOption getRepeatedWallTimeOption(void) const;
void setSkippedWallTimeOption(UCalendarWallTimeOption option);
UCalendarWallTimeOption getSkippedWallTimeOption(void) const;
void setFirstDayOfWeek(UCalendarDaysOfWeek value);
#ifndef U_HIDE_DEPRECATED_API
EDaysOfWeek getFirstDayOfWeek(void) const;
#endif /* U_HIDE_DEPRECATED_API */
UCalendarDaysOfWeek getFirstDayOfWeek(UErrorCode &status) const;
void setMinimalDaysInFirstWeek(uint8_t value);
uint8_t getMinimalDaysInFirstWeek(void) const;
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getMinimum(EDateFields field) const;
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getMinimum(UCalendarDateFields field) const;
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getMaximum(EDateFields field) const;
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getMaximum(UCalendarDateFields field) const;
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getGreatestMinimum(EDateFields field) const;
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getGreatestMinimum(UCalendarDateFields field) const;
#ifndef U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getLeastMaximum(EDateFields field) const;
#endif // U_FORCE_HIDE_DEPRECATED_API
virtual int32_t getLeastMaximum(UCalendarDateFields field) const;
#ifndef U_HIDE_DEPRECATED_API
int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
#endif /* U_HIDE_DEPRECATED_API */
virtual int32_t getActualMinimum(UCalendarDateFields field, UErrorCode& status) const;
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const;
int32_t get(UCalendarDateFields field, UErrorCode& status) const;
UBool isSet(UCalendarDateFields field) const;
void set(UCalendarDateFields field, int32_t value);
void set(int32_t year, int32_t month, int32_t date);
void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute);
void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second);
void clear(void);
void clear(UCalendarDateFields field);
virtual UClassID getDynamicClassID(void) const override = 0;
virtual const char * getType() const = 0;
virtual UCalendarWeekdayType getDayOfWeekType(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
virtual int32_t getWeekendTransition(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
virtual UBool isWeekend(UDate date, UErrorCode &status) const;
virtual UBool isWeekend(void) const;
#ifndef U_FORCE_HIDE_DRAFT_API
virtual bool inTemporalLeapYear(UErrorCode& status) const;
virtual const char* getTemporalMonthCode(UErrorCode& status) const;
virtual void setTemporalMonthCode(const char* temporalMonth, UErrorCode& status);
#endif // U_FORCE_HIDE_DRAFT_API
protected:
Calendar(UErrorCode& success);
Calendar(const Calendar& source);
Calendar& operator=(const Calendar& right);
Calendar(TimeZone* zone, const Locale& aLocale, UErrorCode& success);
Calendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
virtual void computeTime(UErrorCode& status);
virtual void computeFields(UErrorCode& status);
double getTimeInMillis(UErrorCode& status) const;
void setTimeInMillis( double millis, UErrorCode& status );
void complete(UErrorCode& status);
#ifndef U_HIDE_DEPRECATED_API
inline int32_t internalGet(EDateFields field) const {return fFields[field];}
#endif /* U_HIDE_DEPRECATED_API */
#ifndef U_HIDE_INTERNAL_API
inline int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const {return fStamp[field]>kUnset ? fFields[field] : defaultValue;}
inline int32_t internalGet(UCalendarDateFields field) const {return fFields[field];}
#endif /* U_HIDE_INTERNAL_API */
virtual int32_t internalGetMonth() const;
virtual int32_t internalGetMonth(int32_t defaultValue) const;
#ifndef U_HIDE_DEPRECATED_API
void internalSet(EDateFields field, int32_t value);
#endif /* U_HIDE_DEPRECATED_API */
inline void internalSet(UCalendarDateFields field, int32_t value);
virtual void prepareGetActual(UCalendarDateFields field, UBool isMinimum, UErrorCode &status);
enum ELimitType {
#ifndef U_HIDE_INTERNAL_API
UCAL_LIMIT_MINIMUM = 0,
UCAL_LIMIT_GREATEST_MINIMUM,
UCAL_LIMIT_LEAST_MAXIMUM,
UCAL_LIMIT_MAXIMUM,
UCAL_LIMIT_COUNT
#endif /* U_HIDE_INTERNAL_API */
};
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const = 0;
virtual int32_t getLimit(UCalendarDateFields field, ELimitType limitType) const;
virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
UBool useMonth) const = 0;
virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const ;
virtual int32_t handleGetYearLength(int32_t eyear) const;
virtual int32_t handleGetExtendedYear() = 0;
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField);
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);
virtual void validateField(UCalendarDateFields field, UErrorCode &status);
#ifndef U_HIDE_INTERNAL_API
int32_t computeJulianDay();
double computeMillisInDay();
int32_t computeZoneOffset(double millis, double millisInDay, UErrorCode &ec);
int32_t newestStamp(UCalendarDateFields start, UCalendarDateFields end, int32_t bestSoFar) const;
static constexpr int32_t kResolveSTOP = -1;
static constexpr int32_t kResolveRemap = 32;
static const UFieldResolutionTable kDatePrecedence[];
static const UFieldResolutionTable kYearPrecedence[];
static const UFieldResolutionTable kDOWPrecedence[];
static const UFieldResolutionTable kMonthPrecedence[];
UCalendarDateFields resolveFields(const UFieldResolutionTable *precedenceTable) const;
#endif /* U_HIDE_INTERNAL_API */
virtual const UFieldResolutionTable* getFieldResolutionTable() const;
#ifndef U_HIDE_INTERNAL_API
UCalendarDateFields newerField(UCalendarDateFields defaultField, UCalendarDateFields alternateField) const;
#endif /* U_HIDE_INTERNAL_API */
private:
int32_t getActualHelper(UCalendarDateFields field, int32_t startValue, int32_t endValue, UErrorCode &status) const;
protected:
UBool fIsTimeSet;
UBool fAreFieldsSet;
UBool fAreAllFieldsSet;
UBool fAreFieldsVirtuallySet;
UDate internalGetTime(void) const { return fTime; }
void internalSetTime(UDate time) { fTime = time; }
int32_t fFields[UCAL_FIELD_COUNT];
#ifndef U_FORCE_HIDE_DEPRECATED_API
UBool fIsSet[UCAL_FIELD_COUNT];
#endif // U_FORCE_HIDE_DEPRECATED_API
enum {
kUnset = 0,
kInternallySet,
kMinimumUserStamp
};
int32_t fStamp[UCAL_FIELD_COUNT];
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status);
#ifndef U_HIDE_INTERNAL_API
int32_t getGregorianYear() const {
return fGregorianYear;
}
int32_t getGregorianMonth() const {
return fGregorianMonth;
}
int32_t getGregorianDayOfYear() const {
return fGregorianDayOfYear;
}
int32_t getGregorianDayOfMonth() const {
return fGregorianDayOfMonth;
}
#endif /* U_HIDE_INTERNAL_API */
virtual int32_t getDefaultMonthInYear(int32_t eyear) ;
virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month);
//-------------------------------------------------------------------------
// Protected utility methods for use by subclasses. These are very handy
// for implementing add, roll, and computeFields.
//-------------------------------------------------------------------------
virtual void pinField(UCalendarDateFields field, UErrorCode& status);
int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek);
#ifndef U_HIDE_INTERNAL_API
inline int32_t weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek);
int32_t getLocalDOW();
#endif /* U_HIDE_INTERNAL_API */
private:
int32_t fNextStamp;// = MINIMUM_USER_STAMP;
void recalculateStamp();
UDate fTime;
UBool fLenient;
TimeZone* fZone;
UCalendarWallTimeOption fRepeatedWallTime;
UCalendarWallTimeOption fSkippedWallTime;
UCalendarDaysOfWeek fFirstDayOfWeek;
uint8_t fMinimalDaysInFirstWeek;
UCalendarDaysOfWeek fWeekendOnset;
int32_t fWeekendOnsetMillis;
UCalendarDaysOfWeek fWeekendCease;
int32_t fWeekendCeaseMillis;
void setWeekData(const Locale& desiredLocale, const char *type, UErrorCode& success);
void updateTime(UErrorCode& status);
int32_t fGregorianYear;
int32_t fGregorianMonth;
int32_t fGregorianDayOfYear;
int32_t fGregorianDayOfMonth;
/* calculations */
void computeGregorianAndDOWFields(int32_t julianDay, UErrorCode &ec);
protected:
void computeGregorianFields(int32_t julianDay, UErrorCode &ec);
private:
void computeWeekFields(UErrorCode &ec);
void validateFields(UErrorCode &status);
void validateField(UCalendarDateFields field, int32_t min, int32_t max, UErrorCode& status);
protected:
#ifndef U_HIDE_INTERNAL_API
static uint8_t julianDayToDayOfWeek(double julian);
#endif /* U_HIDE_INTERNAL_API */
private:
char validLocale[ULOC_FULLNAME_CAPACITY];
char actualLocale[ULOC_FULLNAME_CAPACITY];
public:
#if !UCONFIG_NO_SERVICE
#ifndef U_HIDE_INTERNAL_API
static StringEnumeration* getAvailableLocales(void);
static URegistryKey registerFactory(ICUServiceFactory* toAdopt, UErrorCode& status);
static UBool unregister(URegistryKey key, UErrorCode& status);
#endif /* U_HIDE_INTERNAL_API */
friend class CalendarFactory;
friend class CalendarService;
friend class DefaultCalendarFactory;
#endif /* !UCONFIG_NO_SERVICE */
virtual UBool haveDefaultCentury() const = 0;
virtual UDate defaultCenturyStart() const = 0;
virtual int32_t defaultCenturyStartYear() const = 0;
Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const;
virtual int32_t getRelatedYear(UErrorCode &status) const;
virtual void setRelatedYear(int32_t year);
#ifndef U_HIDE_INTERNAL_API
const char* getLocaleID(ULocDataLocaleType type, UErrorCode &status) const;
#endif /* U_HIDE_INTERNAL_API */
private:
BasicTimeZone* getBasicTimeZone() const;
UBool getImmediatePreviousZoneTransition(UDate base, UDate *transitionTime, UErrorCode& status) const;
public:
#ifndef U_HIDE_INTERNAL_API
static Calendar * U_EXPORT2 makeInstance(
const Locale &locale, UErrorCode &status);
static void U_EXPORT2 getCalendarTypeFromLocale(
const Locale &locale,
char *typeBuffer,
int32_t typeBufferSize,
UErrorCode &status);
#endif /* U_HIDE_INTERNAL_API */
};
// -------------------------------------
inline Calendar*
Calendar::createInstance(TimeZone* zone, UErrorCode& errorCode)
{
// since the Locale isn't specified, use the default locale
return createInstance(zone, Locale::getDefault(), errorCode);
}
// -------------------------------------
inline void
Calendar::roll(UCalendarDateFields field, UBool up, UErrorCode& status)
{
roll(field, (int32_t)(up ? +1 : -1), status);
}
#ifndef U_HIDE_DEPRECATED_API
inline void
Calendar::roll(EDateFields field, UBool up, UErrorCode& status)
{
roll((UCalendarDateFields) field, up, status);
}
#endif /* U_HIDE_DEPRECATED_API */
// -------------------------------------
inline void
Calendar::internalSet(UCalendarDateFields field, int32_t value)
{
fFields[field] = value;
fStamp[field] = kInternallySet;
fIsSet[field] = true; // Remove later
}
#ifndef U_HIDE_INTERNAL_API
inline int32_t Calendar::weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek)
{
return weekNumber(dayOfPeriod, dayOfPeriod, dayOfWeek);
}
#endif /* U_HIDE_INTERNAL_API */
U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_FORMATTING */
#endif /* U_SHOW_CPLUSPLUS_API */
#endif // _CALENDAR
icu::BasicTimeZone
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:38
icu::Calendar
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition: calendar.h:189
icu::Calendar::after
UBool after(const Calendar &when, UErrorCode &status) const
Returns true if this Calendar's current time is after "when"'s current time.
icu::Calendar::getTemporalMonthCode
virtual const char * getTemporalMonthCode(UErrorCode &status) const
Gets The Temporal monthCode value corresponding to the month for the date.
icu::Calendar::getGreatestMinimum
virtual int32_t getGreatestMinimum(EDateFields field) const
Gets the highest minimum value for the given field if varies.
icu::Calendar::fIsTimeSet
UBool fIsTimeSet
The flag which indicates if the current time is set in the calendar.
Definition: calendar.h:1879
icu::Calendar::setTime
void setTime(UDate date, UErrorCode &status)
Sets this Calendar's current time with the given UDate.
Definition: calendar.h:443
icu::Calendar::setSkippedWallTimeOption
void setSkippedWallTimeOption(UCalendarWallTimeOption option)
Sets the behavior for handling skipped wall time at positive time zone offset transitions.
icu::Calendar::internalGet
int32_t internalGet(UCalendarDateFields field) const
Gets the value for a given time field.
Definition: calendar.h:1552
icu::Calendar::newestStamp
int32_t newestStamp(UCalendarDateFields start, UCalendarDateFields end, int32_t bestSoFar) const
Determine the best stamp in a range.
icu::Calendar::set
void set(UCalendarDateFields field, int32_t value)
Sets the given time field with the given value.
icu::Calendar::getRepeatedWallTimeOption
UCalendarWallTimeOption getRepeatedWallTimeOption(void) const
Gets the behavior for handling wall time repeating multiple times at negative time zone offset transi...
icu::Calendar::getLocale
Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Get the locale for this calendar object.
icu::Calendar::get
int32_t get(UCalendarDateFields field, UErrorCode &status) const
Gets the value for a given time field.
icu::Calendar::operator=
Calendar & operator=(const Calendar &right)
Default assignment operator.
icu::Calendar::clone
virtual Calendar * clone() const =0
Create and return a polymorphic copy of this calendar.
icu::Calendar::getMinimum
virtual int32_t getMinimum(EDateFields field) const
Gets the minimum value for the given time field.
icu::Calendar::getLocalDOW
int32_t getLocalDOW()
returns the local DOW, valid range 0..6
icu::Calendar::roll
virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode &status)
Time Field Rolling function.
icu::Calendar::getDynamicClassID
virtual UClassID getDynamicClassID(void) const override=0
Returns a unique class ID POLYMORPHICALLY.
icu::Calendar::fieldDifference
virtual int32_t fieldDifference(UDate when, UCalendarDateFields field, UErrorCode &status)
Return the difference between the given time and the time this calendar object is set to.
icu::Calendar::weekNumber
int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek)
Return the week number of a day, within a period.
icu::Calendar::getLeastMaximum
virtual int32_t getLeastMaximum(UCalendarDateFields field) const
Gets the lowest maximum value for the given field if varies.
icu::Calendar::handleComputeJulianDay
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField)
Subclasses may override this.
icu::Calendar::setTimeInMillis
void setTimeInMillis(double millis, UErrorCode &status)
Sets this Calendar's current time from the given long value.
icu::Calendar::complete
void complete(UErrorCode &status)
Recomputes the current time from currently set fields, and then fills in any unset fields in the time...
icu::Calendar::getCalendarTypeFromLocale
static void getCalendarTypeFromLocale(const Locale &locale, char *typeBuffer, int32_t typeBufferSize, UErrorCode &status)
Get the calendar type for given locale.
icu::Calendar::isSet
UBool isSet(UCalendarDateFields field) const
Determines if the given time field has a value set.
icu::Calendar::setLenient
void setLenient(UBool lenient)
Specifies whether or not date/time interpretation is to be lenient.
icu::Calendar::getGregorianMonth
int32_t getGregorianMonth() const
Return the month (0-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:1998
icu::Calendar::computeGregorianFields
void computeGregorianFields(int32_t julianDay, UErrorCode &ec)
Compute the Gregorian calendar year, month, and day of month from the Julian day.
icu::Calendar::getGregorianDayOfYear
int32_t getGregorianDayOfYear() const
Return the day of year (1-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:2007
icu::Calendar::haveDefaultCentury
virtual UBool haveDefaultCentury() const =0
icu::Calendar::EDaysOfWeek
EDaysOfWeek
Useful constant for days of week.
Definition: calendar.h:243
icu::Calendar::internalGetMonth
virtual int32_t internalGetMonth(int32_t defaultValue) const
Use this function instead of internalGet(UCAL_MONTH, defaultValue).
icu::Calendar::orphanTimeZone
TimeZone * orphanTimeZone(void)
Returns the time zone owned by this calendar.
icu::Calendar::getLeastMaximum
virtual int32_t getLeastMaximum(EDateFields field) const
Gets the lowest maximum value for the given field if varies.
icu::Calendar::~Calendar
virtual ~Calendar()
destructor
icu::Calendar::EDateFields
EDateFields
Field IDs for date and time.
Definition: calendar.h:198
icu::Calendar::operator==
virtual bool operator==(const Calendar &that) const
Compares the equality of two Calendar objects.
icu::Calendar::roll
virtual void roll(EDateFields field, int32_t amount, UErrorCode &status)
Time Field Rolling function.
icu::Calendar::getKeywordValuesForLocale
static StringEnumeration * getKeywordValuesForLocale(const char *key, const Locale &locale, UBool commonlyUsed, UErrorCode &status)
Given a key and a locale, returns an array of string values in a preferred order that would make a di...
icu::Calendar::ELimitType
ELimitType
Limit enums.
Definition: calendar.h:1615
icu::Calendar::Calendar
Calendar(UErrorCode &success)
Constructs a Calendar with the default time zone as returned by TimeZone::createInstance(),...
icu::Calendar::makeInstance
static Calendar * makeInstance(const Locale &locale, UErrorCode &status)
Creates a new Calendar from a Locale for the cache.
icu::Calendar::equals
UBool equals(const Calendar &when, UErrorCode &status) const
Compares the Calendar time, whereas Calendar::operator== compares the equality of Calendar objects.
icu::Calendar::operator!=
bool operator!=(const Calendar &that) const
Compares the inequality of two Calendar objects.
Definition: calendar.h:466
icu::Calendar::getRelatedYear
virtual int32_t getRelatedYear(UErrorCode &status) const
icu::Calendar::getType
virtual const char * getType() const =0
Returns the calendar type name string for this Calendar object.
icu::Calendar::clear
void clear(UCalendarDateFields field)
Clears the value in the given time field, both making it unset and assigning it a value of zero.
icu::Calendar::handleComputeFields
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status)
Subclasses may override this method to compute several fields specific to each calendar system.
icu::Calendar::setTemporalMonthCode
virtual void setTemporalMonthCode(const char *temporalMonth, UErrorCode &status)
Sets The Temporal monthCode which is a string identifier that starts with the literal grapheme "M" fo...
icu::Calendar::getFieldResolutionTable
virtual const UFieldResolutionTable * getFieldResolutionTable() const
icu::Calendar::fAreFieldsVirtuallySet
UBool fAreFieldsVirtuallySet
True if all fields have been virtually set, but have not yet been computed.
Definition: calendar.h:1907
icu::Calendar::getTimeInMillis
double getTimeInMillis(UErrorCode &status) const
Gets this Calendar's current time as a long.
icu::Calendar::getFirstDayOfWeek
UCalendarDaysOfWeek getFirstDayOfWeek(UErrorCode &status) const
Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
icu::Calendar::getSkippedWallTimeOption
UCalendarWallTimeOption getSkippedWallTimeOption(void) const
Gets the behavior for handling skipped wall time at positive time zone offset transitions.
icu::Calendar::internalGet
int32_t internalGet(EDateFields field) const
Gets the value for a given time field.
Definition: calendar.h:1528
icu::Calendar::registerFactory
static URegistryKey registerFactory(ICUServiceFactory *toAdopt, UErrorCode &status)
Register a new Calendar factory.
icu::Calendar::getDefaultDayInMonth
virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month)
Called by computeJulianDay.
icu::Calendar::fAreFieldsSet
UBool fAreFieldsSet
True if the fields are in sync with the currently set time of this Calendar.
Definition: calendar.h:1891
icu::Calendar::Calendar
Calendar(const Calendar &source)
Copy constructor.
icu::Calendar::computeFields
virtual void computeFields(UErrorCode &status)
Converts GMT as milliseconds to time field values.
icu::Calendar::getActualMaximum
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode &status) const
Return the maximum value that this field could have, given the current date.
icu::Calendar::createInstance
static Calendar * createInstance(const TimeZone &zone, UErrorCode &success)
Creates a Calendar using the given timezone and the default locale.
icu::Calendar::prepareGetActual
virtual void prepareGetActual(UCalendarDateFields field, UBool isMinimum, UErrorCode &status)
Prepare this calendar for computing the actual minimum or maximum.
icu::Calendar::handleGetMonthLength
virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const
Return the number of days in the given month of the given extended year of this calendar system.
icu::Calendar::adoptTimeZone
void adoptTimeZone(TimeZone *value)
Sets the calendar's time zone to be the one passed in.
icu::Calendar::before
UBool before(const Calendar &when, UErrorCode &status) const
Returns true if this Calendar's current time is before "when"'s current time.
icu::Calendar::defaultCenturyStartYear
virtual int32_t defaultCenturyStartYear() const =0
icu::Calendar::setMinimalDaysInFirstWeek
void setMinimalDaysInFirstWeek(uint8_t value)
Sets what the minimal days required in the first week of the year are; For example,...
icu::Calendar::inDaylightTime
virtual UBool inDaylightTime(UErrorCode &status) const
Queries if the current date for this Calendar is in Daylight Savings Time.
icu::Calendar::internalGetMonth
virtual int32_t internalGetMonth() const
Use this function instead of internalGet(UCAL_MONTH).
icu::Calendar::defaultCenturyStart
virtual UDate defaultCenturyStart() const =0
icu::Calendar::getMaximum
virtual int32_t getMaximum(UCalendarDateFields field) const
Gets the maximum value for the given time field.
icu::Calendar::pinField
virtual void pinField(UCalendarDateFields field, UErrorCode &status)
Adjust the specified field so that it is within the allowable range for the date to which this calend...
icu::Calendar::getGregorianYear
int32_t getGregorianYear() const
Return the extended year on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:1989
icu::Calendar::internalGet
int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const
Gets the value for a given time field.
Definition: calendar.h:1542
icu::Calendar::internalSetTime
void internalSetTime(UDate time)
Set the current time without affecting flags or fields.
Definition: calendar.h:1924
icu::Calendar::julianDayToDayOfWeek
static uint8_t julianDayToDayOfWeek(double julian)
Convert a quasi Julian date to the day of the week.
icu::Calendar::getActualMinimum
virtual int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
icu::Calendar::getTime
UDate getTime(UErrorCode &status) const
Gets this Calendar's time as milliseconds.
Definition: calendar.h:431
icu::Calendar::fAreAllFieldsSet
UBool fAreAllFieldsSet
True if all of the fields have been set.
Definition: calendar.h:1898
icu::Calendar::computeJulianDay
int32_t computeJulianDay()
Compute the Julian day from fields.
icu::Calendar::handleGetLimit
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const =0
Subclass API for defining limits of different types.
icu::Calendar::getWeekendTransition
virtual int32_t getWeekendTransition(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const
Returns the time during the day at which the weekend begins or ends in this calendar system.
icu::Calendar::handleGetExtendedYear
virtual int32_t handleGetExtendedYear()=0
Return the extended year defined by the current fields.
icu::Calendar::getActualMinimum
int32_t getActualMinimum(EDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
icu::Calendar::newerField
UCalendarDateFields newerField(UCalendarDateFields defaultField, UCalendarDateFields alternateField) const
Return the field that is newer, either defaultField, or alternateField.
icu::Calendar::isEquivalentTo
virtual UBool isEquivalentTo(const Calendar &other) const
Returns true if the given Calendar object is equivalent to this one.
icu::Calendar::computeMillisInDay
double computeMillisInDay()
Compute the milliseconds in the day from the fields.
icu::Calendar::getFirstDayOfWeek
EDaysOfWeek getFirstDayOfWeek(void) const
Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
icu::Calendar::getGreatestMinimum
virtual int32_t getGreatestMinimum(UCalendarDateFields field) const
Gets the highest minimum value for the given field if varies.
icu::Calendar::getLocaleID
const char * getLocaleID(ULocDataLocaleType type, UErrorCode &status) const
Get the locale for this calendar object.
icu::Calendar::Calendar
Calendar(const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
Constructs a Calendar with the given time zone and locale.
icu::Calendar::setTimeZone
void setTimeZone(const TimeZone &zone)
Sets the calendar's time zone to be the same as the one passed in.
icu::Calendar::getDefaultMonthInYear
virtual int32_t getDefaultMonthInYear(int32_t eyear)
Called by computeJulianDay.
icu::Calendar::EAmpm
EAmpm
Useful constants for hour in 12-hour clock.
Definition: calendar.h:277
icu::Calendar::internalGetTime
UDate internalGetTime(void) const
Get the current time without recomputing.
Definition: calendar.h:1915
icu::Calendar::internalSet
void internalSet(EDateFields field, int32_t value)
Sets the value for a given time field.
icu::Calendar::createInstance
static Calendar * createInstance(const Locale &aLocale, UErrorCode &success)
Creates a Calendar using the default timezone and the given locale.
icu::Calendar::createInstance
static Calendar * createInstance(const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
Gets a Calendar using the given timezone and given locale.
icu::Calendar::setRelatedYear
virtual void setRelatedYear(int32_t year)
icu::Calendar::getNow
static UDate getNow(void)
Returns the current UTC (GMT) time measured in milliseconds since 0:00:00 on 1/1/70 (derived from the...
icu::Calendar::getMinimum
virtual int32_t getMinimum(UCalendarDateFields field) const
Gets the minimum value for the given time field.
icu::Calendar::handleGetExtendedYearFromWeekFields
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy)
Subclasses must override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended ...
icu::Calendar::resolveFields
UCalendarDateFields resolveFields(const UFieldResolutionTable *precedenceTable) const
Given a precedence table, return the newest field combination in the table, or UCAL_FIELD_COUNT if no...
icu::Calendar::setRepeatedWallTimeOption
void setRepeatedWallTimeOption(UCalendarWallTimeOption option)
Sets the behavior for handling wall time repeating multiple times at negative time zone offset transi...
icu::Calendar::setFirstDayOfWeek
void setFirstDayOfWeek(UCalendarDaysOfWeek value)
Sets what the first day of the week is; e.g., Sunday in US, Monday in France.
icu::Calendar::getAvailableLocales
static const Locale * getAvailableLocales(int32_t &count)
Returns a list of the locales for which Calendars are installed.
icu::Calendar::createInstance
static Calendar * createInstance(UErrorCode &success)
Creates a Calendar using the default timezone and locale.
icu::Calendar::inTemporalLeapYear
virtual bool inTemporalLeapYear(UErrorCode &status) const
Returns true if the date is in a leap year.
icu::Calendar::set
void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second)
Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, MINUTE, and SECOND.
icu::Calendar::handleComputeMonthStart
virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month, UBool useMonth) const =0
Return the Julian day number of day before the first day of the given month in the given extended yea...
icu::Calendar::getAvailableLocales
static StringEnumeration * getAvailableLocales(void)
INTERNAL FOR 2.6 – Registration.
icu::Calendar::getDayOfWeekType
virtual UCalendarWeekdayType getDayOfWeekType(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const
Returns whether the given day of the week is a weekday, a weekend day, or a day that transitions from...
icu::Calendar::clear
void clear(void)
Clears the values of all the time fields, making them both unset and assigning them a value of zero.
icu::Calendar::handleGetYearLength
virtual int32_t handleGetYearLength(int32_t eyear) const
Return the number of days in the given extended year of this calendar system.
icu::Calendar::EMonths
EMonths
Useful constants for month.
Definition: calendar.h:257
icu::Calendar::computeTime
virtual void computeTime(UErrorCode &status)
Converts Calendar's time field values to GMT as milliseconds.
icu::Calendar::isWeekend
virtual UBool isWeekend(void) const
Returns true if this Calendar's current date-time is in the weekend in this calendar system.
icu::Calendar::isLenient
UBool isLenient(void) const
Tells whether date/time interpretation is to be lenient.
icu::Calendar::getLimit
virtual int32_t getLimit(UCalendarDateFields field, ELimitType limitType) const
Return a limit for a field.
icu::Calendar::isWeekend
virtual UBool isWeekend(UDate date, UErrorCode &status) const
Returns true if the given UDate is in the weekend in this calendar system.
icu::Calendar::getMaximum
virtual int32_t getMaximum(EDateFields field) const
Gets the maximum value for the given time field.
icu::Calendar::getTimeZone
const TimeZone & getTimeZone(void) const
Returns a reference to the time zone owned by this calendar.
icu::Calendar::add
virtual void add(UCalendarDateFields field, int32_t amount, UErrorCode &status)
UDate Arithmetic function.
icu::Calendar::unregister
static UBool unregister(URegistryKey key, UErrorCode &status)
Unregister a previously-registered CalendarFactory using the key returned from the register call.
icu::Calendar::validateField
virtual void validateField(UCalendarDateFields field, UErrorCode &status)
Validate a single field of this calendar.
icu::Calendar::getMinimalDaysInFirstWeek
uint8_t getMinimalDaysInFirstWeek(void) const
Gets what the minimal days required in the first week of the year are; e.g., if the first week is def...
icu::Calendar::add
virtual void add(EDateFields field, int32_t amount, UErrorCode &status)
UDate Arithmetic function.
icu::Calendar::getGregorianDayOfMonth
int32_t getGregorianDayOfMonth() const
Return the day of month (1-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:2016
icu::Calendar::Calendar
Calendar(TimeZone *zone, const Locale &aLocale, UErrorCode &success)
Constructs a Calendar with the given time zone and locale.
icu::Calendar::computeZoneOffset
int32_t computeZoneOffset(double millis, double millisInDay, UErrorCode &ec)
This method can assume EXTENDED_YEAR has been set.
icu::Calendar::createInstance
static Calendar * createInstance(TimeZone *zoneToAdopt, const Locale &aLocale, UErrorCode &success)
Creates a Calendar using the given timezone and given locale.
icu::Calendar::set
void set(int32_t year, int32_t month, int32_t date)
Sets the values for the fields YEAR, MONTH, and DATE.
icu::Calendar::set
void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute)
Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, and MINUTE.
icu::Calendar::fieldDifference
virtual int32_t fieldDifference(UDate when, EDateFields field, UErrorCode &status)
Return the difference between the given time and the time this calendar object is set to.
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
icu::StringEnumeration
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
icu::TimeZone
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
locid.h
C++ API: Locale ID object.
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
icu::UFieldResolutionTable
int32_t UFieldResolutionTable[12][8]
Definition: calendar.h:48
timezone.h
C++ API: TimeZone object.
ucal.h
C API: Calendar.
UCalendarDateFields
UCalendarDateFields
Possible fields in a UCalendar.
Definition: ucal.h:202
UCAL_FIELD_COUNT
@ UCAL_FIELD_COUNT
One more than the highest normal UCalendarDateFields value.
Definition: ucal.h:483
UCalendarWallTimeOption
UCalendarWallTimeOption
Options for handling ambiguous wall time at time zone offset transitions.
Definition: ucal.h:998
UCalendarWeekdayType
UCalendarWeekdayType
Weekday types, as returned by ucal_getDayOfWeekType().
Definition: ucal.h:1464
UCalendarDaysOfWeek
UCalendarDaysOfWeek
Useful constant for days of week.
Definition: ucal.h:509
ULOC_FULLNAME_CAPACITY
#define ULOC_FULLNAME_CAPACITY
Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all k...
Definition: uloc.h:264
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
umisc.h
C API: Miscellaneous definitions.
URegistryKey
const void * URegistryKey
Opaque type returned by registerInstance, registerFactory and unregister for service registration.
Definition: umisc.h:57
uobject.h
C++ API: Common ICU base class UObject.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301
UDate
double UDate
Date and Time data type.
Definition: utypes.h:203