ICU 4.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rbtz.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2007-2008, International Business Machines Corporation and *
4 * others. All Rights Reserved. *
5 *******************************************************************************
6 */
7 #ifndef RBTZ_H
8 #define RBTZ_H
9 
10 #include "unicode/utypes.h"
11 
17 #if !UCONFIG_NO_FORMATTING
18 
19 #include "unicode/basictz.h"
20 #include "unicode/unistr.h"
21 
23 
24 // forward declaration
25 class UVector;
26 struct Transition;
27 
35 public:
45  RuleBasedTimeZone(const UnicodeString& id, InitialTimeZoneRule* initialRule);
46 
52  RuleBasedTimeZone(const RuleBasedTimeZone& source);
53 
58  virtual ~RuleBasedTimeZone();
59 
66 
75  virtual UBool operator==(const TimeZone& that) const;
76 
85  virtual UBool operator!=(const TimeZone& that) const;
86 
102  void addTransitionRule(TimeZoneRule* rule, UErrorCode& status);
103 
113  void complete(UErrorCode& status);
114 
122  virtual TimeZone* clone(void) const;
123 
148  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
149  uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const;
150 
170  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
171  uint8_t dayOfWeek, int32_t millis,
172  int32_t monthLength, UErrorCode& status) const;
173 
196  virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
197  int32_t& dstOffset, UErrorCode& ec) const;
198 
206  virtual void setRawOffset(int32_t offsetMillis);
207 
215  virtual int32_t getRawOffset(void) const;
216 
223  virtual UBool useDaylightTime(void) const;
224 
238  virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
239 
248  virtual UBool hasSameRules(const TimeZone& other) const;
249 
258  virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) /*const*/;
259 
268  virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) /*const*/;
269 
278  virtual int32_t countTransitionRules(UErrorCode& status) /*const*/;
279 
296  virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
297  const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) /*const*/;
298 
303  virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt,
304  int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) /*const*/;
305 
306 private:
307  void deleteRules(void);
308  void deleteTransitions(void);
309  UVector* copyRules(UVector* source);
310  TimeZoneRule* findRuleInFinal(UDate date, UBool local,
311  int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
312  UBool findNext(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
313  UBool findPrev(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
314  int32_t getLocalDelta(int32_t rawBefore, int32_t dstBefore, int32_t rawAfter, int32_t dstAfter,
315  int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
316  UDate getTransitionTime(Transition* transition, UBool local,
317  int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
318  void getOffsetInternal(UDate date, UBool local, int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt,
319  int32_t& rawOffset, int32_t& dstOffset, UErrorCode& ec) const;
320 
321  InitialTimeZoneRule *fInitialRule;
322  UVector *fHistoricRules;
323  UVector *fFinalRules;
324  UVector *fHistoricTransitions;
325  UBool fUpToDate;
326 
327 public:
339  static UClassID U_EXPORT2 getStaticClassID(void);
340 
352  virtual UClassID getDynamicClassID(void) const;
353 };
354 
356 
357 #endif /* #if !UCONFIG_NO_FORMATTING */
358 
359 #endif // RBTZ_H
360 
361 //eof
virtual void setRawOffset(int32_t offsetMillis)=0
Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time...
virtual void getTimeZoneRules(const InitialTimeZoneRule *&initial, const TimeZoneRule *trsrules[], int32_t &trscount, UErrorCode &status)=0
Gets the InitialTimeZoneRule and the set of TimeZoneRule which represent time transitions for this ti...
double UDate
Date and Time data type.
Definition: utypes.h:281
C++ API: Unicode String.
virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &status)
Get time zone offsets from local wall time.
UBool operator!=(const TimeZone &that) const
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false...
Definition: timezone.h:389
a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances ...
Definition: rbtz.h:34
TimeZoneRule is a class representing a rule for time zone.
Definition: tzrule.h:32
unsigned char uint8_t
Define 64 bit limits.
Definition: pwin32.h:131
C++ API: ICU TimeZone base class.
TimeZoneTransition is a class representing a time zone transition.
Definition: tztrans.h:31
TimeZone & operator=(const TimeZone &right)
Default assignment operator.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:475
virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition &result)=0
Gets the first time zone transition after the base time.
virtual UClassID getDynamicClassID(void) const =0
Returns a unique class ID POLYMORPHICALLY.
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:183
static UClassID getStaticClassID(void)
Return the class ID for this class.
InitialTimeZoneRule represents a time zone rule representing a time zone effective from the beginning...
Definition: tzrule.h:198
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...
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:34
virtual TimeZone * clone(void) const =0
Clones TimeZone objects polymorphically.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:187
#define U_EXPORT2
Definition: platform.h:338
virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition &result)=0
Gets the most recent time zone transition before the base time.
virtual UBool hasSameRules(const TimeZone &other) const
Returns true if this zone has the same rule and offset as another zone.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API If the compiler doesn't support namespaces...
Definition: uversion.h:184
virtual int32_t getRawOffset(void) const =0
Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local ti...
void * UClassID
UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...
Definition: utypes.h:339
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:593
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:122
Basic definitions for ICU, for both C and C++ APIs.
virtual int32_t countTransitionRules(UErrorCode &status)=0
Returns the number of TimeZoneRules which represents time transitions, for this time zone...
virtual UBool inDaylightTime(UDate date, UErrorCode &status) const =0
Queries if the given date is in daylight savings time in this time zone.
virtual UBool operator==(const TimeZone &that) const
Returns true if the two TimeZones are equal.
virtual UBool useDaylightTime(void) const =0
Queries if this time zone uses daylight savings time.
signed int int32_t
Define 64 bit limits.
Definition: pwin32.h:143
int8_t UBool
The ICU boolean type.
Definition: umachine.h:208