ICU 67.1  67.1
simpletz.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4  ********************************************************************************
5  * Copyright (C) 1997-2013, International Business Machines *
6  * Corporation and others. All Rights Reserved. *
7  ********************************************************************************
8  *
9  * File SIMPLETZ.H
10  *
11  * Modification History:
12  *
13  * Date Name Description
14  * 04/21/97 aliu Overhauled header.
15  * 08/10/98 stephen JDK 1.2 sync
16  * Added setStartRule() / setEndRule() overloads
17  * Added hasSameRules()
18  * 09/02/98 stephen Added getOffset(monthLen)
19  * Changed getOffset() to take UErrorCode
20  * 07/09/99 stephen Removed millisPerHour (unused, for HP compiler)
21  * 12/02/99 aliu Added TimeMode and constructor and setStart/EndRule
22  * methods that take TimeMode. Added to docs.
23  ********************************************************************************
24  */
25 
26 #ifndef SIMPLETZ_H
27 #define SIMPLETZ_H
28 
29 #include "unicode/utypes.h"
30 
31 #if U_SHOW_CPLUSPLUS_API
32 
38 #if !UCONFIG_NO_FORMATTING
39 
40 #include "unicode/basictz.h"
41 
42 U_NAMESPACE_BEGIN
43 
44 // forward declaration
45 class InitialTimeZoneRule;
46 class TimeZoneTransition;
47 class AnnualTimeZoneRule;
48 
66 public:
67 
79  enum TimeMode {
80  WALL_TIME = 0,
81  STANDARD_TIME,
82  UTC_TIME
83  };
84 
91 
98 
103  virtual ~SimpleTimeZone();
104 
114  virtual UBool operator==(const TimeZone& that) const;
115 
127  SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString& ID);
128 
164  SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString& ID,
165  int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth,
166  int8_t savingsStartDayOfWeek, int32_t savingsStartTime,
167  int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth,
168  int8_t savingsEndDayOfWeek, int32_t savingsEndTime,
169  UErrorCode& status);
207  SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString& ID,
208  int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth,
209  int8_t savingsStartDayOfWeek, int32_t savingsStartTime,
210  int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth,
211  int8_t savingsEndDayOfWeek, int32_t savingsEndTime,
212  int32_t savingsDST, UErrorCode& status);
213 
255  SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString& ID,
256  int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth,
257  int8_t savingsStartDayOfWeek, int32_t savingsStartTime,
258  TimeMode savingsStartTimeMode,
259  int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth,
260  int8_t savingsEndDayOfWeek, int32_t savingsEndTime, TimeMode savingsEndTimeMode,
261  int32_t savingsDST, UErrorCode& status);
262 
271  void setStartYear(int32_t year);
272 
315  void setStartRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek,
316  int32_t time, UErrorCode& status);
361  void setStartRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek,
362  int32_t time, TimeMode mode, UErrorCode& status);
363 
375  void setStartRule(int32_t month, int32_t dayOfMonth, int32_t time,
376  UErrorCode& status);
390  void setStartRule(int32_t month, int32_t dayOfMonth, int32_t time,
391  TimeMode mode, UErrorCode& status);
392 
409  void setStartRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
410  int32_t time, UBool after, UErrorCode& status);
429  void setStartRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
430  int32_t time, TimeMode mode, UBool after, UErrorCode& status);
431 
454  void setEndRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek,
455  int32_t time, UErrorCode& status);
456 
481  void setEndRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek,
482  int32_t time, TimeMode mode, UErrorCode& status);
483 
495  void setEndRule(int32_t month, int32_t dayOfMonth, int32_t time, UErrorCode& status);
496 
510  void setEndRule(int32_t month, int32_t dayOfMonth, int32_t time,
511  TimeMode mode, UErrorCode& status);
512 
529  void setEndRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
530  int32_t time, UBool after, UErrorCode& status);
531 
550  void setEndRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
551  int32_t time, TimeMode mode, UBool after, UErrorCode& status);
552 
573  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
574  uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const;
575 
591  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
592  uint8_t dayOfWeek, int32_t milliseconds,
593  int32_t monthLength, UErrorCode& status) const;
610  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
611  uint8_t dayOfWeek, int32_t milliseconds,
612  int32_t monthLength, int32_t prevMonthLength,
613  UErrorCode& status) const;
614 
620  virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
621  int32_t& dstOffset, UErrorCode& ec) const;
622 
627  virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt,
628  int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) const;
629 
637  virtual int32_t getRawOffset(void) const;
638 
646  virtual void setRawOffset(int32_t offsetMillis);
647 
657  void setDSTSavings(int32_t millisSavedDuringDST, UErrorCode& status);
658 
667  virtual int32_t getDSTSavings(void) const;
668 
675  virtual UBool useDaylightTime(void) const;
676 
677 #ifndef U_FORCE_HIDE_DEPRECATED_API
678 
692  virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
693 #endif // U_FORCE_HIDE_DEPRECATED_API
694 
701  UBool hasSameRules(const TimeZone& other) const;
702 
710  virtual SimpleTimeZone* clone() const;
711 
720  virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
721 
730  virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
731 
740  virtual int32_t countTransitionRules(UErrorCode& status) const;
741 
758  virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
759  const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) const;
760 
761 
762 public:
763 
774  virtual UClassID getDynamicClassID(void) const;
775 
787  static UClassID U_EXPORT2 getStaticClassID(void);
788 
789 private:
793  enum EMode
794  {
795  DOM_MODE = 1,
796  DOW_IN_MONTH_MODE,
797  DOW_GE_DOM_MODE,
798  DOW_LE_DOM_MODE
799  };
800 
801  SimpleTimeZone(); // default constructor not implemented
802 
822  void construct(int32_t rawOffsetGMT,
823  int8_t startMonth, int8_t startDay, int8_t startDayOfWeek,
824  int32_t startTime, TimeMode startTimeMode,
825  int8_t endMonth, int8_t endDay, int8_t endDayOfWeek,
826  int32_t endTime, TimeMode endTimeMode,
827  int32_t dstSavings, UErrorCode& status);
828 
838  static int32_t compareToRule(int8_t month, int8_t monthLen, int8_t prevMonthLen,
839  int8_t dayOfMonth,
840  int8_t dayOfWeek, int32_t millis, int32_t millisDelta,
841  EMode ruleMode, int8_t ruleMonth, int8_t ruleDayOfWeek,
842  int8_t ruleDay, int32_t ruleMillis);
843 
859  void decodeRules(UErrorCode& status);
860  void decodeStartRule(UErrorCode& status);
861  void decodeEndRule(UErrorCode& status);
862 
863  int8_t startMonth, startDay, startDayOfWeek; // the month, day, DOW, and time DST starts
864  int32_t startTime;
865  TimeMode startTimeMode, endTimeMode; // Mode for startTime, endTime; see TimeMode
866  int8_t endMonth, endDay, endDayOfWeek; // the month, day, DOW, and time DST ends
867  int32_t endTime;
868  int32_t startYear; // the year these DST rules took effect
869  int32_t rawOffset; // the TimeZone's raw GMT offset
870  UBool useDaylight; // flag indicating whether this TimeZone uses DST
871  static const int8_t STATICMONTHLENGTH[12]; // lengths of the months
872  EMode startMode, endMode; // flags indicating what kind of rules the DST rules are
873 
878  int32_t dstSavings;
879 
880  /* Private for BasicTimeZone implementation */
881  void checkTransitionRules(UErrorCode& status) const;
882  void initTransitionRules(UErrorCode& status);
883  void clearTransitionRules(void);
884  void deleteTransitionRules(void);
885  UBool transitionRulesInitialized;
886  InitialTimeZoneRule* initialRule;
887  TimeZoneTransition* firstTransition;
888  AnnualTimeZoneRule* stdRule;
889  AnnualTimeZoneRule* dstRule;
890 };
891 
892 inline void SimpleTimeZone::setStartRule(int32_t month, int32_t dayOfWeekInMonth,
893  int32_t dayOfWeek,
894  int32_t time, UErrorCode& status) {
895  setStartRule(month, dayOfWeekInMonth, dayOfWeek, time, WALL_TIME, status);
896 }
897 
898 inline void SimpleTimeZone::setStartRule(int32_t month, int32_t dayOfMonth,
899  int32_t time,
900  UErrorCode& status) {
901  setStartRule(month, dayOfMonth, time, WALL_TIME, status);
902 }
903 
904 inline void SimpleTimeZone::setStartRule(int32_t month, int32_t dayOfMonth,
905  int32_t dayOfWeek,
906  int32_t time, UBool after, UErrorCode& status) {
907  setStartRule(month, dayOfMonth, dayOfWeek, time, WALL_TIME, after, status);
908 }
909 
910 inline void SimpleTimeZone::setEndRule(int32_t month, int32_t dayOfWeekInMonth,
911  int32_t dayOfWeek,
912  int32_t time, UErrorCode& status) {
913  setEndRule(month, dayOfWeekInMonth, dayOfWeek, time, WALL_TIME, status);
914 }
915 
916 inline void SimpleTimeZone::setEndRule(int32_t month, int32_t dayOfMonth,
917  int32_t time, UErrorCode& status) {
918  setEndRule(month, dayOfMonth, time, WALL_TIME, status);
919 }
920 
921 inline void SimpleTimeZone::setEndRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
922  int32_t time, UBool after, UErrorCode& status) {
923  setEndRule(month, dayOfMonth, dayOfWeek, time, WALL_TIME, after, status);
924 }
925 
926 inline void
927 SimpleTimeZone::getOffset(UDate date, UBool local, int32_t& rawOffsetRef,
928  int32_t& dstOffsetRef, UErrorCode& ec) const {
929  TimeZone::getOffset(date, local, rawOffsetRef, dstOffsetRef, ec);
930 }
931 
932 U_NAMESPACE_END
933 
934 #endif /* #if !UCONFIG_NO_FORMATTING */
935 
936 #endif /* U_SHOW_CPLUSPLUS_API */
937 
938 #endif // _SIMPLETZ
icu::SimpleTimeZone::useDaylightTime
virtual UBool useDaylightTime(void) const
Queries if this TimeZone uses Daylight Savings Time.
icu::SimpleTimeZone::SimpleTimeZone
SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString &ID)
Constructs a SimpleTimeZone with the given raw GMT offset and time zone ID, and which doesn't observe...
icu::SimpleTimeZone::operator=
SimpleTimeZone & operator=(const SimpleTimeZone &right)
Default assignment operator.
icu::SimpleTimeZone::getPreviousTransition
virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const
Gets the most recent time zone transition before the base time.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
icu::SimpleTimeZone::setRawOffset
virtual void setRawOffset(int32_t offsetMillis)
Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time,...
icu::SimpleTimeZone::getStaticClassID
static UClassID getStaticClassID(void)
Return the class ID for this class.
icu::SimpleTimeZone::clone
virtual SimpleTimeZone * clone() const
Clones TimeZone objects polymorphically.
U_I18N_API
#define U_I18N_API
Definition: utypes.h:301
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261
icu::SimpleTimeZone::setStartRule
void setStartRule(int32_t month, int32_t dayOfMonth, int32_t time, TimeMode mode, UErrorCode &status)
Sets the DST start rule to a fixed date within a month.
icu::BasicTimeZone
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:38
icu::SimpleTimeZone::setStartRule
void setStartRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek, int32_t time, TimeMode mode, UErrorCode &status)
Sets the daylight savings starting rule.
icu::SimpleTimeZone::getTimeZoneRules
virtual void getTimeZoneRules(const InitialTimeZoneRule *&initial, const TimeZoneRule *trsrules[], int32_t &trscount, UErrorCode &status) const
Gets the InitialTimeZoneRule and the set of TimeZoneRule which represent time transitions for this ti...
icu::TimeZoneRule
TimeZoneRule is a class representing a rule for time zone.
Definition: tzrule.h:36
icu::TimeZone
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
icu::SimpleTimeZone::setEndRule
void setEndRule(int32_t month, int32_t dayOfWeekInMonth, int32_t dayOfWeek, int32_t time, TimeMode mode, UErrorCode &status)
Sets the daylight savings ending rule.
icu::SimpleTimeZone::inDaylightTime
virtual UBool inDaylightTime(UDate date, UErrorCode &status) const
Returns true if the given date is within the period when daylight savings time is in effect; false ot...
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:295
icu::SimpleTimeZone::setStartYear
void setStartYear(int32_t year)
Sets the daylight savings starting year, that is, the year this time zone began observing its specifi...
icu::SimpleTimeZone::~SimpleTimeZone
virtual ~SimpleTimeZone()
Destructor.
icu::SimpleTimeZone::getOffsetFromLocal
virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &status) const
Get time zone offsets from local wall time.
icu::AnnualTimeZoneRule
AnnualTimeZoneRule is a class used for representing a time zone rule which takes effect annually.
Definition: tzrule.h:380
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
icu::SimpleTimeZone::getOffset
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t milliseconds, int32_t monthLength, UErrorCode &status) const
Gets the time zone offset, for current date, modified in case of daylight savings.
basictz.h
C++ API: ICU TimeZone base class.
icu::SimpleTimeZone::getOffset
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t milliseconds, int32_t monthLength, int32_t prevMonthLength, UErrorCode &status) const
Gets the time zone offset, for current date, modified in case of daylight savings.
icu::TimeZone::getOffset
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, UErrorCode &status) const =0
Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get loc...
icu::SimpleTimeZone
SimpleTimeZone is a concrete subclass of TimeZone that represents a time zone for use with a Gregoria...
Definition: simpletz.h:65
icu::SimpleTimeZone::SimpleTimeZone
SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString &ID, int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth, int8_t savingsStartDayOfWeek, int32_t savingsStartTime, int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth, int8_t savingsEndDayOfWeek, int32_t savingsEndTime, UErrorCode &status)
Construct a SimpleTimeZone with the given raw GMT offset, time zone ID, and times to start and end da...
icu::SimpleTimeZone::SimpleTimeZone
SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString &ID, int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth, int8_t savingsStartDayOfWeek, int32_t savingsStartTime, int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth, int8_t savingsEndDayOfWeek, int32_t savingsEndTime, int32_t savingsDST, UErrorCode &status)
Construct a SimpleTimeZone with the given raw GMT offset, time zone ID, and times to start and end da...
icu::InitialTimeZoneRule
InitialTimeZoneRule represents a time zone rule representing a time zone effective from the beginning...
Definition: tzrule.h:202
icu::TimeZoneTransition
TimeZoneTransition is a class representing a time zone transition.
Definition: tztrans.h:35
icu::SimpleTimeZone::TimeMode
TimeMode
TimeMode is used, together with a millisecond offset after midnight, to specify a rule transition tim...
Definition: simpletz.h:79
icu::SimpleTimeZone::getNextTransition
virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const
Gets the first time zone transition after the base time.
UDate
double UDate
Date and Time data type.
Definition: utypes.h:203
icu::SimpleTimeZone::SimpleTimeZone
SimpleTimeZone(const SimpleTimeZone &source)
Copy constructor.
icu::SimpleTimeZone::getDSTSavings
virtual int32_t getDSTSavings(void) const
Returns the amount of time in ms that the clock is advanced during DST.
icu::SimpleTimeZone::setEndRule
void setEndRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek, int32_t time, TimeMode mode, UBool after, UErrorCode &status)
Sets the DST end rule to a weekday before or after a give date within a month, e.g....
icu::SimpleTimeZone::hasSameRules
UBool hasSameRules(const TimeZone &other) const
Return true if this zone has the same rules and offset as another zone.
icu::SimpleTimeZone::setDSTSavings
void setDSTSavings(int32_t millisSavedDuringDST, UErrorCode &status)
Sets the amount of time in ms that the clock is advanced during DST.
icu::SimpleTimeZone::getRawOffset
virtual int32_t getRawOffset(void) const
Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local ti...
icu::SimpleTimeZone::SimpleTimeZone
SimpleTimeZone(int32_t rawOffsetGMT, const UnicodeString &ID, int8_t savingsStartMonth, int8_t savingsStartDayOfWeekInMonth, int8_t savingsStartDayOfWeek, int32_t savingsStartTime, TimeMode savingsStartTimeMode, int8_t savingsEndMonth, int8_t savingsEndDayOfWeekInMonth, int8_t savingsEndDayOfWeek, int32_t savingsEndTime, TimeMode savingsEndTimeMode, int32_t savingsDST, UErrorCode &status)
Construct a SimpleTimeZone with the given raw GMT offset, time zone ID, and times to start and end da...
icu::SimpleTimeZone::setStartRule
void setStartRule(int32_t month, int32_t dayOfMonth, int32_t dayOfWeek, int32_t time, TimeMode mode, UBool after, UErrorCode &status)
Sets the DST start rule to a weekday before or after a give date within a month, e....
icu::SimpleTimeZone::getOffset
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, UErrorCode &status) const
Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get loc...
icu::SimpleTimeZone::operator==
virtual UBool operator==(const TimeZone &that) const
Returns true if the two TimeZone objects are equal; that is, they have the same ID,...
icu::SimpleTimeZone::getDynamicClassID
virtual UClassID getDynamicClassID(void) const
Override TimeZone Returns a unique class ID POLYMORPHICALLY.
icu::SimpleTimeZone::countTransitionRules
virtual int32_t countTransitionRules(UErrorCode &status) const
Returns the number of TimeZoneRules which represents time transitions, for this time zone,...
icu::SimpleTimeZone::setEndRule
void setEndRule(int32_t month, int32_t dayOfMonth, int32_t time, TimeMode mode, UErrorCode &status)
Sets the DST end rule to a fixed date within a month.