ICU 69.1 69.1

vtzone.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 VTZONE_H
10 #define VTZONE_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
25 U_NAMESPACE_BEGIN
26
27 class VTZWriter;
28 class VTZReader;
29 class UVector;
30
45 class U_I18N_API VTimeZone : public BasicTimeZone {
46 public:
52 VTimeZone(const VTimeZone& source);
53
58 virtual ~VTimeZone();
59
65 VTimeZone& operator=(const VTimeZone& right);
66
75 virtual UBool operator==(const TimeZone& that) const;
76
85 virtual UBool operator!=(const TimeZone& that) const;
86
94 static VTimeZone* createVTimeZoneByID(const UnicodeString& ID);
95
103 static VTimeZone* createVTimeZoneFromBasicTimeZone(const BasicTimeZone& basicTZ,
104 UErrorCode &status);
105
115 static VTimeZone* createVTimeZone(const UnicodeString& vtzdata, UErrorCode& status);
116
125 UBool getTZURL(UnicodeString& url) const;
126
132 void setTZURL(const UnicodeString& url);
133
142 UBool getLastModified(UDate& lastModified) const;
143
149 void setLastModified(UDate lastModified);
150
157 void write(UnicodeString& result, UErrorCode& status) const;
158
167 void write(UDate start, UnicodeString& result, UErrorCode& status) const;
168
182 void writeSimple(UDate time, UnicodeString& result, UErrorCode& status) const;
183
190 virtual VTimeZone* clone() const;
191
216 virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
217 uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const;
218
238 virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
239 uint8_t dayOfWeek, int32_t millis,
240 int32_t monthLength, UErrorCode& status) const;
241
264 virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
265 int32_t& dstOffset, UErrorCode& ec) const;
266
267 #ifndef U_FORCE_HIDE_DRAFT_API
268
272 virtual void getOffsetFromLocal(
273 UDate date, UTimeZoneLocalOption nonExistingTimeOpt,
274 UTimeZoneLocalOption duplicatedTimeOpt,
275 int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) const;
276 #endif /* U_FORCE_HIDE_DRAFT_API */
277
285 virtual void setRawOffset(int32_t offsetMillis);
286
294 virtual int32_t getRawOffset(void) const;
295
302 virtual UBool useDaylightTime(void) const;
303
304 #ifndef U_FORCE_HIDE_DEPRECATED_API
305
318 virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
319 #endif // U_FORCE_HIDE_DEPRECATED_API
320
329 virtual UBool hasSameRules(const TimeZone& other) const;
330
339 virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
340
349 virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
350
359 virtual int32_t countTransitionRules(UErrorCode& status) const;
360
377 virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
378 const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) const;
379
380 private:
381 enum { DEFAULT_VTIMEZONE_LINES = 100 };
382
386 VTimeZone();
387 static VTimeZone* createVTimeZone(VTZReader* reader);
388 void write(VTZWriter& writer, UErrorCode& status) const;
389 void write(UDate start, VTZWriter& writer, UErrorCode& status) const;
390 void writeSimple(UDate time, VTZWriter& writer, UErrorCode& status) const;
391 void load(VTZReader& reader, UErrorCode& status);
392 void parse(UErrorCode& status);
393
394 void writeZone(VTZWriter& w, BasicTimeZone& basictz, UVector* customProps,
395 UErrorCode& status) const;
396
397 void writeHeaders(VTZWriter& w, UErrorCode& status) const;
398 void writeFooter(VTZWriter& writer, UErrorCode& status) const;
399
400 void writeZonePropsByTime(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
401 int32_t fromOffset, int32_t toOffset, UDate time, UBool withRDATE,
402 UErrorCode& status) const;
403 void writeZonePropsByDOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
404 int32_t fromOffset, int32_t toOffset,
405 int32_t month, int32_t dayOfMonth, UDate startTime, UDate untilTime,
406 UErrorCode& status) const;
407 void writeZonePropsByDOW(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
408 int32_t fromOffset, int32_t toOffset,
409 int32_t month, int32_t weekInMonth, int32_t dayOfWeek,
410 UDate startTime, UDate untilTime, UErrorCode& status) const;
411 void writeZonePropsByDOW_GEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
412 int32_t fromOffset, int32_t toOffset,
413 int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
414 UDate startTime, UDate untilTime, UErrorCode& status) const;
415 void writeZonePropsByDOW_GEQ_DOM_sub(VTZWriter& writer, int32_t month, int32_t dayOfMonth,
416 int32_t dayOfWeek, int32_t numDays,
417 UDate untilTime, int32_t fromOffset, UErrorCode& status) const;
418 void writeZonePropsByDOW_LEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
419 int32_t fromOffset, int32_t toOffset,
420 int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
421 UDate startTime, UDate untilTime, UErrorCode& status) const;
422 void writeFinalRule(VTZWriter& writer, UBool isDst, const AnnualTimeZoneRule* rule,
423 int32_t fromRawOffset, int32_t fromDSTSavings,
424 UDate startTime, UErrorCode& status) const;
425
426 void beginZoneProps(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
427 int32_t fromOffset, int32_t toOffset, UDate startTime, UErrorCode& status) const;
428 void endZoneProps(VTZWriter& writer, UBool isDst, UErrorCode& status) const;
429 void beginRRULE(VTZWriter& writer, int32_t month, UErrorCode& status) const;
430 void appendUNTIL(VTZWriter& writer, const UnicodeString& until, UErrorCode& status) const;
431
432 BasicTimeZone *tz;
433 UVector *vtzlines;
434 UnicodeString tzurl;
435 UDate lastmod;
436 UnicodeString olsonzid;
437 UnicodeString icutzver;
438
439 public:
451 static UClassID U_EXPORT2 getStaticClassID(void);
452
464 virtual UClassID getDynamicClassID(void) const;
465 };
466
467 U_NAMESPACE_END
468
469 #endif /* #if !UCONFIG_NO_FORMATTING */
470
471 #endif /* U_SHOW_CPLUSPLUS_API */
472
473 #endif // VTZONE_H
474 //eof
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
icu::VTimeZone
VTimeZone is a class implementing RFC2445 VTIMEZONE.
Definition: vtzone.h:45
icu::TimeZone::inDaylightTime
virtual UBool inDaylightTime(UDate date, UErrorCode &status) const =0
Queries if the given date is in daylight savings time in this time zone.
U_I18N_API
#define U_I18N_API
Definition: utypes.h:301
icu::TimeZone::setRawOffset
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,...
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
icu::TimeZone::operator==
virtual UBool operator==(const TimeZone &that) const
Returns true if the two TimeZones are equal.
icu::BasicTimeZone
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:38
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::TimeZone::getStaticClassID
static UClassID getStaticClassID(void)
Return the class ID for this class.
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:295
icu::BasicTimeZone::getNextTransition
virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const =0
Gets the first time zone transition after the base 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
basictz.h
C++ API: ICU TimeZone base class.
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::TimeZone::getDynamicClassID
virtual UClassID getDynamicClassID(void) const =0
Returns a unique class ID POLYMORPHICALLY.
icu::InitialTimeZoneRule
InitialTimeZoneRule represents a time zone rule representing a time zone effective from the beginning...
Definition: tzrule.h:202
icu::BasicTimeZone::countTransitionRules
virtual int32_t countTransitionRules(UErrorCode &status) const =0
Returns the number of TimeZoneRules which represents time transitions, for this time zone,...
icu::TimeZoneTransition
TimeZoneTransition is a class representing a time zone transition.
Definition: tztrans.h:35
icu::BasicTimeZone::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.
UTimeZoneLocalOption
UTimeZoneLocalOption
Options used by ucal_getTimeZoneOffsetFromLocal and BasicTimeZone::getOffsetFromLocal() to specify ho...
Definition: ucal.h:1627
UDate
double UDate
Date and Time data type.
Definition: utypes.h:203
icu::BasicTimeZone::operator=
BasicTimeZone & operator=(const BasicTimeZone &)=default
Copy assignment.
icu::TimeZone::useDaylightTime
virtual UBool useDaylightTime(void) const =0
Queries if this time zone uses daylight savings time.
icu::TimeZone::hasSameRules
virtual UBool hasSameRules(const TimeZone &other) const
Returns true if this zone has the same rule and offset as another zone.
icu::BasicTimeZone::clone
virtual BasicTimeZone * clone() const =0
Clones this object polymorphically.
icu::TimeZone::operator!=
UBool operator!=(const TimeZone &that) const
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false.
Definition: timezone.h:472
icu::BasicTimeZone::getPreviousTransition
virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition &result) const =0
Gets the most recent time zone transition before the base time.
icu::BasicTimeZone::getTimeZoneRules
virtual void getTimeZoneRules(const InitialTimeZoneRule *&initial, const TimeZoneRule *trsrules[], int32_t &trscount, UErrorCode &status) const =0
Gets the InitialTimeZoneRule and the set of TimeZoneRule which represent time transitions for this ti...
icu::TimeZone::getRawOffset
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...