ICU 69.1: rbtz.h Source File

ICU 69.1 69.1

rbtz.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) 2007-2013, International Business Machines Corporation and *
6 * others. All Rights Reserved. *
7 *******************************************************************************
8 */
9 #ifndef RBTZ_H
10 #define RBTZ_H
11
12 #include "unicode/utypes.h"
13
14 #if U_SHOW_CPLUSPLUS_API
15
21 #if !UCONFIG_NO_FORMATTING
22
23 #include "unicode/basictz.h"
24 #include "unicode/unistr.h"
25
26 U_NAMESPACE_BEGIN
27
28 // forward declaration
29 class UVector;
30 struct Transition;
31
38 class U_I18N_API RuleBasedTimeZone : public BasicTimeZone {
39 public:
49 RuleBasedTimeZone(const UnicodeString& id, InitialTimeZoneRule* initialRule);
50
56 RuleBasedTimeZone(const RuleBasedTimeZone& source);
57
62 virtual ~RuleBasedTimeZone();
63
69 RuleBasedTimeZone& operator=(const RuleBasedTimeZone& right);
70
79 virtual UBool operator==(const TimeZone& that) const;
80
89 virtual UBool operator!=(const TimeZone& that) const;
90
106 void addTransitionRule(TimeZoneRule* rule, UErrorCode& status);
107
117 void complete(UErrorCode& status);
118
126 virtual RuleBasedTimeZone* clone() const;
127
152 virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
153 uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const;
154
174 virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
175 uint8_t dayOfWeek, int32_t millis,
176 int32_t monthLength, UErrorCode& status) const;
177
200 virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
201 int32_t& dstOffset, UErrorCode& ec) const;
202
210 virtual void setRawOffset(int32_t offsetMillis);
211
219 virtual int32_t getRawOffset(void) const;
220
227 virtual UBool useDaylightTime(void) const;
228
229 #ifndef U_FORCE_HIDE_DEPRECATED_API
243 virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
244 #endif // U_FORCE_HIDE_DEPRECATED_API
245
254 virtual UBool hasSameRules(const TimeZone& other) const;
255
264 virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
265
274 virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
275
284 virtual int32_t countTransitionRules(UErrorCode& status) const;
285
302 virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
303 const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) const;
304
305 #ifndef U_FORCE_HIDE_DRAFT_API
310 virtual void getOffsetFromLocal(
311 UDate date, UTimeZoneLocalOption nonExistingTimeOpt,
312 UTimeZoneLocalOption duplicatedTimeOpt,
313 int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) const;
314 #endif /* U_FORCE_HIDE_DRAFT_API */
315
316 private:
317 void deleteRules(void);
318 void deleteTransitions(void);
319 UVector* copyRules(UVector* source);
320 TimeZoneRule* findRuleInFinal(UDate date, UBool local,
321 int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
322 UBool findNext(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
323 UBool findPrev(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
324 int32_t getLocalDelta(int32_t rawBefore, int32_t dstBefore, int32_t rawAfter, int32_t dstAfter,
325 int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
326 UDate getTransitionTime(Transition* transition, UBool local,
327 int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
328 void getOffsetInternal(UDate date, UBool local, int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt,
329 int32_t& rawOffset, int32_t& dstOffset, UErrorCode& ec) const;
330 void completeConst(UErrorCode &status) const;
331
332 InitialTimeZoneRule *fInitialRule;
333 UVector *fHistoricRules;
334 UVector *fFinalRules;
335 UVector *fHistoricTransitions;
336 UBool fUpToDate;
337
338 public:
350 static UClassID U_EXPORT2 getStaticClassID(void);
351
363 virtual UClassID getDynamicClassID(void) const;
364 };
365
366 U_NAMESPACE_END
367
368 #endif /* #if !UCONFIG_NO_FORMATTING */
369
370 #endif /* U_SHOW_CPLUSPLUS_API */
371
372 #endif // RBTZ_H
373
374 //eof
basictz.h
C++ API: ICU TimeZone base class.
icu::BasicTimeZone
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:38
icu::InitialTimeZoneRule
InitialTimeZoneRule represents a time zone rule representing a time zone effective from the beginning...
Definition: tzrule.h:202
icu::RuleBasedTimeZone
a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances
Definition: rbtz.h:38
icu::RuleBasedTimeZone::~RuleBasedTimeZone
virtual ~RuleBasedTimeZone()
Destructor.
icu::RuleBasedTimeZone::useDaylightTime
virtual UBool useDaylightTime(void) const
Queries if this time zone uses daylight savings time.
icu::RuleBasedTimeZone::hasSameRules
virtual UBool hasSameRules(const TimeZone &other) const
Returns true if this zone has the same rule and offset as another zone.
icu::RuleBasedTimeZone::getOffsetFromLocal
virtual void getOffsetFromLocal(UDate date, UTimeZoneLocalOption nonExistingTimeOpt, UTimeZoneLocalOption duplicatedTimeOpt, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &status) const
Get time zone offsets from local wall time.
icu::RuleBasedTimeZone::complete
void complete(UErrorCode &status)
Makes the TimeZoneRule ready to handle actual timezone calculation APIs.
icu::RuleBasedTimeZone::clone
virtual RuleBasedTimeZone * clone() const
Clones TimeZone objects polymorphically.
icu::RuleBasedTimeZone::inDaylightTime
virtual UBool inDaylightTime(UDate date, UErrorCode &status) const
Queries if the given date is in daylight savings time in this time zone.
icu::RuleBasedTimeZone::getDynamicClassID
virtual UClassID getDynamicClassID(void) const
Returns a unique class ID POLYMORPHICALLY.
icu::RuleBasedTimeZone::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::RuleBasedTimeZone::addTransitionRule
void addTransitionRule(TimeZoneRule *rule, UErrorCode &status)
Adds the TimeZoneRule which represents time transitions.
icu::RuleBasedTimeZone::operator==
virtual UBool operator==(const TimeZone &that) const
Return true if the given TimeZone objects are semantically equal.
icu::RuleBasedTimeZone::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::RuleBasedTimeZone::getPreviousTransition
virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const
Gets the most recent time zone transition before the base time.
icu::RuleBasedTimeZone::RuleBasedTimeZone
RuleBasedTimeZone(const RuleBasedTimeZone &source)
Copy constructor.
icu::RuleBasedTimeZone::getOffset
virtual void getOffset(UDate date, UBool local, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &ec) const
Returns the time zone raw and GMT offset for the given moment in time.
icu::RuleBasedTimeZone::getStaticClassID
static UClassID getStaticClassID(void)
Return the class ID for this class.
icu::RuleBasedTimeZone::countTransitionRules
virtual int32_t countTransitionRules(UErrorCode &status) const
Returns the number of TimeZoneRules which represents time transitions, for this time zone,...
icu::RuleBasedTimeZone::RuleBasedTimeZone
RuleBasedTimeZone(const UnicodeString &id, InitialTimeZoneRule *initialRule)
Constructs a RuleBasedTimeZone object with the ID and the InitialTimeZoneRule.
icu::RuleBasedTimeZone::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::RuleBasedTimeZone::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::RuleBasedTimeZone::operator=
RuleBasedTimeZone & operator=(const RuleBasedTimeZone &right)
Assignment operator.
icu::RuleBasedTimeZone::getOffset
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, int32_t monthLength, UErrorCode &status) const
Gets the time zone offset, for current date, modified in case of daylight savings.
icu::RuleBasedTimeZone::getNextTransition
virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const
Gets the first time zone transition after the base time.
icu::RuleBasedTimeZone::operator!=
virtual UBool operator!=(const TimeZone &that) const
Return true if the given TimeZone objects are semantically unequal.
icu::TimeZoneRule
TimeZoneRule is a class representing a rule for time zone.
Definition: tzrule.h:36
icu::TimeZoneTransition
TimeZoneTransition is a class representing a time zone transition.
Definition: tztrans.h:35
icu::TimeZone
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
UTimeZoneLocalOption
UTimeZoneLocalOption
Options used by ucal_getTimeZoneOffsetFromLocal and BasicTimeZone::getOffsetFromLocal() to specify ho...
Definition: ucal.h:1627
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
unistr.h
C++ API: Unicode String.
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