[apple/icu.git] / icuSources / i18n / unicode / rbtz.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2007-2013, International Business Machines Corporation and    *
* others. All Rights Reserved.                                                *
*******************************************************************************
*/
#ifndef RBTZ_H
#define RBTZ_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

/**
 * \file 
 * \brief C++ API: Rule based customizable time zone
 */

#if !UCONFIG_NO_FORMATTING

#include "unicode/basictz.h"
#include "unicode/unistr.h"

U_NAMESPACE_BEGIN

// forward declaration
class UVector;
struct Transition;

/**
 * a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances
 * @see BasicTimeZone
 * @see InitialTimeZoneRule
 * @see TimeZoneRule
 */
class U_I18N_API RuleBasedTimeZone : public BasicTimeZone {
public:
    /**
     * Constructs a <code>RuleBasedTimeZone</code> object with the ID and the
     * <code>InitialTimeZoneRule</code>.  The input <code>InitialTimeZoneRule</code>
     * is adopted by this <code>RuleBasedTimeZone</code>, thus the caller must not
     * delete it.
     * @param id                The time zone ID.
     * @param initialRule       The initial time zone rule.
     * @stable ICU 3.8
     */
    RuleBasedTimeZone(const UnicodeString& id, InitialTimeZoneRule* initialRule);

    /**
     * Copy constructor.
     * @param source    The RuleBasedTimeZone object to be copied.
     * @stable ICU 3.8
     */
    RuleBasedTimeZone(const RuleBasedTimeZone& source);

    /**
     * Destructor.
     * @stable ICU 3.8
     */
    virtual ~RuleBasedTimeZone();

    /**
     * Assignment operator.
     * @param right The object to be copied.
     * @stable ICU 3.8
     */
    RuleBasedTimeZone& operator=(const RuleBasedTimeZone& right);

    /**
     * Return true if the given <code>TimeZone</code> objects are
     * semantically equal. Objects of different subclasses are considered unequal.
     * @param that  The object to be compared with.
     * @return  true if the given <code>TimeZone</code> objects are
      *semantically equal.
     * @stable ICU 3.8
     */
    virtual UBool operator==(const TimeZone& that) const;

    /**
     * Return true if the given <code>TimeZone</code> objects are
     * semantically unequal. Objects of different subclasses are considered unequal.
     * @param that  The object to be compared with.
     * @return  true if the given <code>TimeZone</code> objects are
     * semantically unequal.
     * @stable ICU 3.8
     */
    virtual UBool operator!=(const TimeZone& that) const;

    /**
     * Adds the <code>TimeZoneRule</code> which represents time transitions.
     * The <code>TimeZoneRule</code> must have start times, that is, the result
     * of isTransitionRule() must be true. Otherwise, U_ILLEGAL_ARGUMENT_ERROR
     * is set to the error code.
     * The input <code>TimeZoneRule</code> is adopted by this
     * <code>RuleBasedTimeZone</code> on successful completion of this method,
     * thus, the caller must not delete it when no error is returned.
     * After all rules are added, the caller must call complete() method to
     * make this <code>RuleBasedTimeZone</code> ready to handle common time
     * zone functions.
     * @param rule The <code>TimeZoneRule</code>.
     * @param status Output param to filled in with a success or an error.
     * @stable ICU 3.8
     */
    void addTransitionRule(TimeZoneRule* rule, UErrorCode& status);

    /**
     * Makes the <code>TimeZoneRule</code> ready to handle actual timezone
     * calcuation APIs.  This method collects time zone rules specified
     * by the caller via the constructor and addTransitionRule() and
     * builds internal structure for making the object ready to support
     * time zone APIs such as getOffset(), getNextTransition() and others.
     * @param status Output param to filled in with a success or an error.
     * @stable ICU 3.8
     */
    void complete(UErrorCode& status);

    /**
     * Clones TimeZone objects polymorphically. Clients are responsible for deleting
     * the TimeZone object cloned.
     *
     * @return   A new copy of this TimeZone object.
     * @stable ICU 3.8
     */
    virtual RuleBasedTimeZone* clone() const;

    /**
     * Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add
     * to GMT to get local time in this time zone, taking daylight savings time into
     * account) as of a particular reference date.  The reference date is used to determine
     * whether daylight savings time is in effect and needs to be figured into the offset
     * that is returned (in other words, what is the adjusted GMT offset in this time zone
     * at this particular date and time?).  For the time zones produced by createTimeZone(),
     * the reference data is specified according to the Gregorian calendar, and the date
     * and time fields are local standard time.
     *
     * <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
     * which returns both the raw and the DST offset for a given time. This method
     * is retained only for backward compatibility.
     *
     * @param era        The reference date's era
     * @param year       The reference date's year
     * @param month      The reference date's month (0-based; 0 is January)
     * @param day        The reference date's day-in-month (1-based)
     * @param dayOfWeek  The reference date's day-of-week (1-based; 1 is Sunday)
     * @param millis     The reference date's milliseconds in day, local standard time
     * @param status     Output param to filled in with a success or an error.
     * @return           The offset in milliseconds to add to GMT to get local time.
     * @stable ICU 3.8
     */
    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;

    /**
     * Gets the time zone offset, for current date, modified in case of
     * daylight savings. This is the offset to add *to* UTC to get local time.
     *
     * <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
     * which returns both the raw and the DST offset for a given time. This method
     * is retained only for backward compatibility.
     *
     * @param era        The reference date's era
     * @param year       The reference date's year
     * @param month      The reference date's month (0-based; 0 is January)
     * @param day        The reference date's day-in-month (1-based)
     * @param dayOfWeek  The reference date's day-of-week (1-based; 1 is Sunday)
     * @param millis     The reference date's milliseconds in day, local standard time
     * @param monthLength The length of the given month in days.
     * @param status     Output param to filled in with a success or an error.
     * @return           The offset in milliseconds to add to GMT to get local time.
     * @stable ICU 3.8
     */
    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;

    /**
     * Returns the time zone raw and GMT offset for the given moment
     * in time.  Upon return, local-millis = GMT-millis + rawOffset +
     * dstOffset.  All computations are performed in the proleptic
     * Gregorian calendar.  The default implementation in the TimeZone
     * class delegates to the 8-argument getOffset().
     *
     * @param date moment in time for which to return offsets, in
     * units of milliseconds from January 1, 1970 0:00 GMT, either GMT
     * time or local wall time, depending on `local'.
     * @param local if true, `date' is local wall time; otherwise it
     * is in GMT time.
     * @param rawOffset output parameter to receive the raw offset, that
     * is, the offset not including DST adjustments
     * @param dstOffset output parameter to receive the DST offset,
     * that is, the offset to be added to `rawOffset' to obtain the
     * total offset between local and GMT time. If DST is not in
     * effect, this value is zero; otherwise it is a positive value,
     * typically one hour.
     * @param ec input-output error code
     * @stable ICU 3.8
     */
    virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
                           int32_t& dstOffset, UErrorCode& ec) const;

    /**
     * Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
     * to GMT to get local time, before taking daylight savings time into account).
     *
     * @param offsetMillis  The new raw GMT offset for this time zone.
     * @stable ICU 3.8
     */
    virtual void setRawOffset(int32_t offsetMillis);

    /**
     * Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
     * to GMT to get local time, before taking daylight savings time into account).
     *
     * @return   The TimeZone's raw GMT offset.
     * @stable ICU 3.8
     */
    virtual int32_t getRawOffset(void) const;

    /**
     * Queries if this time zone uses daylight savings time.
     * @return true if this time zone uses daylight savings time,
     * false, otherwise.
     * @stable ICU 3.8
     */
    virtual UBool useDaylightTime(void) const;

#ifndef U_FORCE_HIDE_DEPRECATED_API
    /**
     * Queries if the given date is in daylight savings time in
     * this time zone.
     * This method is wasteful since it creates a new GregorianCalendar and
     * deletes it each time it is called. This is a deprecated method
     * and provided only for Java compatibility.
     *
     * @param date the given UDate.
     * @param status Output param filled in with success/error code.
     * @return true if the given date is in daylight savings time,
     * false, otherwise.
     * @deprecated ICU 2.4. Use Calendar::inDaylightTime() instead.
     */
    virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
#endif  // U_FORCE_HIDE_DEPRECATED_API

    /**
     * Returns true if this zone has the same rule and offset as another zone.
     * That is, if this zone differs only in ID, if at all.
     * @param other the <code>TimeZone</code> object to be compared with
     * @return true if the given zone is the same as this one,
     * with the possible exception of the ID
     * @stable ICU 3.8
     */
    virtual UBool hasSameRules(const TimeZone& other) const;

    /**
     * Gets the first time zone transition after the base time.
     * @param base      The base time.
     * @param inclusive Whether the base time is inclusive or not.
     * @param result    Receives the first transition after the base time.
     * @return  TRUE if the transition is found.
     * @stable ICU 3.8
     */
    virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;

    /**
     * Gets the most recent time zone transition before the base time.
     * @param base      The base time.
     * @param inclusive Whether the base time is inclusive or not.
     * @param result    Receives the most recent transition before the base time.
     * @return  TRUE if the transition is found.
     * @stable ICU 3.8
     */
    virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;

    /**
     * Returns the number of <code>TimeZoneRule</code>s which represents time transitions,
     * for this time zone, that is, all <code>TimeZoneRule</code>s for this time zone except
     * <code>InitialTimeZoneRule</code>.  The return value range is 0 or any positive value.
     * @param status    Receives error status code.
     * @return The number of <code>TimeZoneRule</code>s representing time transitions.
     * @stable ICU 3.8
     */
    virtual int32_t countTransitionRules(UErrorCode& status) const;

    /**
     * Gets the <code>InitialTimeZoneRule</code> and the set of <code>TimeZoneRule</code>
     * which represent time transitions for this time zone.  On successful return,
     * the argument initial points to non-NULL <code>InitialTimeZoneRule</code> and
     * the array trsrules is filled with 0 or multiple <code>TimeZoneRule</code>
     * instances up to the size specified by trscount.  The results are referencing the
     * rule instance held by this time zone instance.  Therefore, after this time zone
     * is destructed, they are no longer available.
     * @param initial       Receives the initial timezone rule
     * @param trsrules      Receives the timezone transition rules
     * @param trscount      On input, specify the size of the array 'transitions' receiving
     *                      the timezone transition rules.  On output, actual number of
     *                      rules filled in the array will be set.
     * @param status        Receives error status code.
     * @stable ICU 3.8
     */
    virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
        const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) const;

    /**
     * Get time zone offsets from local wall time.
     * @internal
     */
    virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt,
        int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) const;

private:
    void deleteRules(void);
    void deleteTransitions(void);
    UVector* copyRules(UVector* source);
    TimeZoneRule* findRuleInFinal(UDate date, UBool local,
        int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
    UBool findNext(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
    UBool findPrev(UDate base, UBool inclusive, UDate& time, TimeZoneRule*& from, TimeZoneRule*& to) const;
    int32_t getLocalDelta(int32_t rawBefore, int32_t dstBefore, int32_t rawAfter, int32_t dstAfter,
        int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
    UDate getTransitionTime(Transition* transition, UBool local,
        int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
    void getOffsetInternal(UDate date, UBool local, int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt,
        int32_t& rawOffset, int32_t& dstOffset, UErrorCode& ec) const;
    void completeConst(UErrorCode &status) const;

    InitialTimeZoneRule *fInitialRule;
    UVector             *fHistoricRules;
    UVector             *fFinalRules;
    UVector             *fHistoricTransitions;
    UBool               fUpToDate;

public:
    /**
     * Return the class ID for this class. This is useful only for comparing to
     * a return value from getDynamicClassID(). For example:
     * <pre>
     * .   Base* polymorphic_pointer = createPolymorphicObject();
     * .   if (polymorphic_pointer->getDynamicClassID() ==
     * .       erived::getStaticClassID()) ...
     * </pre>
     * @return          The class ID for all objects of this class.
     * @stable ICU 3.8
     */
    static UClassID U_EXPORT2 getStaticClassID(void);

    /**
     * Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This
     * method is to implement a simple version of RTTI, since not all C++
     * compilers support genuine RTTI. Polymorphic operator==() and clone()
     * methods call this method.
     *
     * @return          The class ID for this object. All objects of a
     *                  given class have the same class ID.  Objects of
     *                  other classes have different class IDs.
     * @stable ICU 3.8
     */
    virtual UClassID getDynamicClassID(void) const;
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // RBTZ_H

//eof
Commit	Line	Data
f3c0d7a5 A	1	// © 2016 and later: Unicode, Inc. and others.
f3c0d7a5 A	2	// License & terms of use: http://www.unicode.org/copyright.html
46f4442e A	3	/*
46f4442e A	4	*******************************************************************************
51004dcb	5	* Copyright (C) 2007-2013, International Business Machines Corporation and *
46f4442e A	6	* others. All Rights Reserved. *
	7	*******************************************************************************
	8	*/
	9	#ifndef RBTZ_H
	10	#define RBTZ_H
	11
	12	#include "unicode/utypes.h"
	13
340931cb A	14	#if U_SHOW_CPLUSPLUS_API
340931cb A	15
46f4442e A	16	/**
	17	* \file
	18	* \brief C++ API: Rule based customizable time zone
	19	*/
	20
	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
	32	/**
	33	* a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances
	34	* @see BasicTimeZone
	35	* @see InitialTimeZoneRule
	36	* @see TimeZoneRule
	37	*/
	38	class U_I18N_API RuleBasedTimeZone : public BasicTimeZone {
	39	public:
	40	/**
	41	* Constructs a <code>RuleBasedTimeZone</code> object with the ID and the
	42	* <code>InitialTimeZoneRule</code>. The input <code>InitialTimeZoneRule</code>
	43	* is adopted by this <code>RuleBasedTimeZone</code>, thus the caller must not
	44	* delete it.
	45	* @param id The time zone ID.
	46	* @param initialRule The initial time zone rule.
729e4ab9	47	* @stable ICU 3.8
46f4442e A	48	*/
	49	RuleBasedTimeZone(const UnicodeString& id, InitialTimeZoneRule* initialRule);
	50
	51	/**
	52	* Copy constructor.
	53	* @param source The RuleBasedTimeZone object to be copied.
729e4ab9	54	* @stable ICU 3.8
46f4442e A	55	*/
	56	RuleBasedTimeZone(const RuleBasedTimeZone& source);
	57
	58	/**
	59	* Destructor.
729e4ab9	60	* @stable ICU 3.8
46f4442e A	61	*/
	62	virtual ~RuleBasedTimeZone();
	63
	64	/**
	65	* Assignment operator.
	66	* @param right The object to be copied.
729e4ab9	67	* @stable ICU 3.8
46f4442e A	68	*/
	69	RuleBasedTimeZone& operator=(const RuleBasedTimeZone& right);
	70
	71	/**
	72	* Return true if the given <code>TimeZone</code> objects are
	73	* semantically equal. Objects of different subclasses are considered unequal.
	74	* @param that The object to be compared with.
	75	* @return true if the given <code>TimeZone</code> objects are
	76	*semantically equal.
729e4ab9	77	* @stable ICU 3.8
46f4442e A	78	*/
	79	virtual UBool operator==(const TimeZone& that) const;
	80
	81	/**
	82	* Return true if the given <code>TimeZone</code> objects are
	83	* semantically unequal. Objects of different subclasses are considered unequal.
	84	* @param that The object to be compared with.
	85	* @return true if the given <code>TimeZone</code> objects are
	86	* semantically unequal.
729e4ab9	87	* @stable ICU 3.8
46f4442e A	88	*/
	89	virtual UBool operator!=(const TimeZone& that) const;
	90
	91	/**
	92	* Adds the <code>TimeZoneRule</code> which represents time transitions.
	93	* The <code>TimeZoneRule</code> must have start times, that is, the result
	94	* of isTransitionRule() must be true. Otherwise, U_ILLEGAL_ARGUMENT_ERROR
	95	* is set to the error code.
	96	* The input <code>TimeZoneRule</code> is adopted by this
	97	* <code>RuleBasedTimeZone</code> on successful completion of this method,
	98	* thus, the caller must not delete it when no error is returned.
	99	* After all rules are added, the caller must call complete() method to
	100	* make this <code>RuleBasedTimeZone</code> ready to handle common time
	101	* zone functions.
	102	* @param rule The <code>TimeZoneRule</code>.
	103	* @param status Output param to filled in with a success or an error.
729e4ab9	104	* @stable ICU 3.8
46f4442e A	105	*/
	106	void addTransitionRule(TimeZoneRule* rule, UErrorCode& status);
	107
	108	/**
	109	* Makes the <code>TimeZoneRule</code> ready to handle actual timezone
	110	* calcuation APIs. This method collects time zone rules specified
	111	* by the caller via the constructor and addTransitionRule() and
	112	* builds internal structure for making the object ready to support
	113	* time zone APIs such as getOffset(), getNextTransition() and others.
	114	* @param status Output param to filled in with a success or an error.
729e4ab9	115	* @stable ICU 3.8
46f4442e A	116	*/
	117	void complete(UErrorCode& status);
	118
	119	/**
	120	* Clones TimeZone objects polymorphically. Clients are responsible for deleting
	121	* the TimeZone object cloned.
	122	*
	123	* @return A new copy of this TimeZone object.
729e4ab9	124	* @stable ICU 3.8
46f4442e	125	*/
340931cb	126	virtual RuleBasedTimeZone* clone() const;
46f4442e A	127
	128	/**
	129	* Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add
	130	* to GMT to get local time in this time zone, taking daylight savings time into
	131	* account) as of a particular reference date. The reference date is used to determine
	132	* whether daylight savings time is in effect and needs to be figured into the offset
	133	* that is returned (in other words, what is the adjusted GMT offset in this time zone
	134	* at this particular date and time?). For the time zones produced by createTimeZone(),
	135	* the reference data is specified according to the Gregorian calendar, and the date
	136	* and time fields are local standard time.
	137	*
	138	* <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
	139	* which returns both the raw and the DST offset for a given time. This method
	140	* is retained only for backward compatibility.
	141	*
	142	* @param era The reference date's era
	143	* @param year The reference date's year
	144	* @param month The reference date's month (0-based; 0 is January)
	145	* @param day The reference date's day-in-month (1-based)
	146	* @param dayOfWeek The reference date's day-of-week (1-based; 1 is Sunday)
	147	* @param millis The reference date's milliseconds in day, local standard time
	148	* @param status Output param to filled in with a success or an error.
	149	* @return The offset in milliseconds to add to GMT to get local time.
729e4ab9	150	* @stable ICU 3.8
46f4442e A	151	*/
	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
	155	/**
	156	* Gets the time zone offset, for current date, modified in case of
	157	* daylight savings. This is the offset to add to UTC to get local time.
	158	*
	159	* <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
	160	* which returns both the raw and the DST offset for a given time. This method
	161	* is retained only for backward compatibility.
	162	*
	163	* @param era The reference date's era
	164	* @param year The reference date's year
	165	* @param month The reference date's month (0-based; 0 is January)
	166	* @param day The reference date's day-in-month (1-based)
	167	* @param dayOfWeek The reference date's day-of-week (1-based; 1 is Sunday)
	168	* @param millis The reference date's milliseconds in day, local standard time
	169	* @param monthLength The length of the given month in days.
	170	* @param status Output param to filled in with a success or an error.
	171	* @return The offset in milliseconds to add to GMT to get local time.
729e4ab9	172	* @stable ICU 3.8
46f4442e A	173	*/
	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
	178	/**
	179	* Returns the time zone raw and GMT offset for the given moment
	180	* in time. Upon return, local-millis = GMT-millis + rawOffset +
	181	* dstOffset. All computations are performed in the proleptic
	182	* Gregorian calendar. The default implementation in the TimeZone
	183	* class delegates to the 8-argument getOffset().
	184	*
	185	* @param date moment in time for which to return offsets, in
	186	* units of milliseconds from January 1, 1970 0:00 GMT, either GMT
	187	* time or local wall time, depending on `local'.
	188	* @param local if true, `date' is local wall time; otherwise it
	189	* is in GMT time.
	190	* @param rawOffset output parameter to receive the raw offset, that
	191	* is, the offset not including DST adjustments
	192	* @param dstOffset output parameter to receive the DST offset,
	193	* that is, the offset to be added to `rawOffset' to obtain the
	194	* total offset between local and GMT time. If DST is not in
	195	* effect, this value is zero; otherwise it is a positive value,
	196	* typically one hour.
	197	* @param ec input-output error code
729e4ab9	198	* @stable ICU 3.8
46f4442e A	199	*/
	200	virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
	201	int32_t& dstOffset, UErrorCode& ec) const;
	202
	203	/**
	204	* Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
	205	* to GMT to get local time, before taking daylight savings time into account).
	206	*
	207	* @param offsetMillis The new raw GMT offset for this time zone.
729e4ab9	208	* @stable ICU 3.8
46f4442e A	209	*/
	210	virtual void setRawOffset(int32_t offsetMillis);
	211
	212	/**
	213	* Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
	214	* to GMT to get local time, before taking daylight savings time into account).
	215	*
	216	* @return The TimeZone's raw GMT offset.
729e4ab9	217	* @stable ICU 3.8
46f4442e A	218	*/
	219	virtual int32_t getRawOffset(void) const;
	220
	221	/**
	222	* Queries if this time zone uses daylight savings time.
	223	* @return true if this time zone uses daylight savings time,
	224	* false, otherwise.
729e4ab9	225	* @stable ICU 3.8
46f4442e A	226	*/
	227	virtual UBool useDaylightTime(void) const;
	228
340931cb	229	#ifndef U_FORCE_HIDE_DEPRECATED_API
46f4442e A	230	/**
	231	* Queries if the given date is in daylight savings time in
	232	* this time zone.
	233	* This method is wasteful since it creates a new GregorianCalendar and
	234	* deletes it each time it is called. This is a deprecated method
	235	* and provided only for Java compatibility.
	236	*
	237	* @param date the given UDate.
	238	* @param status Output param filled in with success/error code.
	239	* @return true if the given date is in daylight savings time,
	240	* false, otherwise.
	241	* @deprecated ICU 2.4. Use Calendar::inDaylightTime() instead.
	242	*/
	243	virtual UBool inDaylightTime(UDate date, UErrorCode& status) const;
340931cb	244	#endif // U_FORCE_HIDE_DEPRECATED_API
46f4442e A	245
	246	/**
	247	* Returns true if this zone has the same rule and offset as another zone.
	248	* That is, if this zone differs only in ID, if at all.
	249	* @param other the <code>TimeZone</code> object to be compared with
	250	* @return true if the given zone is the same as this one,
	251	* with the possible exception of the ID
729e4ab9	252	* @stable ICU 3.8
46f4442e A	253	*/
	254	virtual UBool hasSameRules(const TimeZone& other) const;
	255
	256	/**
	257	* Gets the first time zone transition after the base time.
	258	* @param base The base time.
	259	* @param inclusive Whether the base time is inclusive or not.
	260	* @param result Receives the first transition after the base time.
	261	* @return TRUE if the transition is found.
729e4ab9	262	* @stable ICU 3.8
46f4442e	263	*/
51004dcb	264	virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
46f4442e A	265
	266	/**
	267	* Gets the most recent time zone transition before the base time.
	268	* @param base The base time.
	269	* @param inclusive Whether the base time is inclusive or not.
	270	* @param result Receives the most recent transition before the base time.
	271	* @return TRUE if the transition is found.
729e4ab9	272	* @stable ICU 3.8
46f4442e	273	*/
51004dcb	274	virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) const;
46f4442e A	275
	276	/**
	277	* Returns the number of <code>TimeZoneRule</code>s which represents time transitions,
	278	* for this time zone, that is, all <code>TimeZoneRule</code>s for this time zone except
	279	* <code>InitialTimeZoneRule</code>. The return value range is 0 or any positive value.
	280	* @param status Receives error status code.
	281	* @return The number of <code>TimeZoneRule</code>s representing time transitions.
729e4ab9	282	* @stable ICU 3.8
46f4442e	283	*/
51004dcb	284	virtual int32_t countTransitionRules(UErrorCode& status) const;
46f4442e A	285
	286	/**
	287	* Gets the <code>InitialTimeZoneRule</code> and the set of <code>TimeZoneRule</code>
	288	* which represent time transitions for this time zone. On successful return,
	289	* the argument initial points to non-NULL <code>InitialTimeZoneRule</code> and
	290	* the array trsrules is filled with 0 or multiple <code>TimeZoneRule</code>
	291	* instances up to the size specified by trscount. The results are referencing the
	292	* rule instance held by this time zone instance. Therefore, after this time zone
	293	* is destructed, they are no longer available.
	294	* @param initial Receives the initial timezone rule
	295	* @param trsrules Receives the timezone transition rules
	296	* @param trscount On input, specify the size of the array 'transitions' receiving
	297	* the timezone transition rules. On output, actual number of
	298	* rules filled in the array will be set.
	299	* @param status Receives error status code.
729e4ab9	300	* @stable ICU 3.8
46f4442e A	301	*/
46f4442e A	302	virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
51004dcb	303	const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) const;
46f4442e A	304
	305	/**
	306	* Get time zone offsets from local wall time.
	307	* @internal
	308	*/
	309	virtual void getOffsetFromLocal(UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt,
51004dcb	310	int32_t& rawOffset, int32_t& dstOffset, UErrorCode& status) const;
46f4442e A	311
	312	private:
	313	void deleteRules(void);
	314	void deleteTransitions(void);
	315	UVector* copyRules(UVector* source);
	316	TimeZoneRule* findRuleInFinal(UDate date, UBool local,
	317	int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
	318	UBool findNext(UDate base, UBool inclusive, UDate& time, TimeZoneRule& from, TimeZoneRule& to) const;
	319	UBool findPrev(UDate base, UBool inclusive, UDate& time, TimeZoneRule& from, TimeZoneRule& to) const;
	320	int32_t getLocalDelta(int32_t rawBefore, int32_t dstBefore, int32_t rawAfter, int32_t dstAfter,
	321	int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
	322	UDate getTransitionTime(Transition* transition, UBool local,
	323	int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt) const;
	324	void getOffsetInternal(UDate date, UBool local, int32_t NonExistingTimeOpt, int32_t DuplicatedTimeOpt,
	325	int32_t& rawOffset, int32_t& dstOffset, UErrorCode& ec) const;
51004dcb	326	void completeConst(UErrorCode &status) const;
46f4442e A	327
	328	InitialTimeZoneRule *fInitialRule;
	329	UVector *fHistoricRules;
	330	UVector *fFinalRules;
	331	UVector *fHistoricTransitions;
	332	UBool fUpToDate;
	333
	334	public:
	335	/**
	336	* Return the class ID for this class. This is useful only for comparing to
	337	* a return value from getDynamicClassID(). For example:
	338	* <pre>
	339	* . Base* polymorphic_pointer = createPolymorphicObject();
	340	* . if (polymorphic_pointer->getDynamicClassID() ==
	341	* . erived::getStaticClassID()) ...
	342	* </pre>
	343	* @return The class ID for all objects of this class.
729e4ab9	344	* @stable ICU 3.8
46f4442e A	345	*/
	346	static UClassID U_EXPORT2 getStaticClassID(void);
	347
	348	/**
	349	* Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This
	350	* method is to implement a simple version of RTTI, since not all C++
	351	* compilers support genuine RTTI. Polymorphic operator==() and clone()
	352	* methods call this method.
	353	*
	354	* @return The class ID for this object. All objects of a
	355	* given class have the same class ID. Objects of
	356	* other classes have different class IDs.
729e4ab9	357	* @stable ICU 3.8
46f4442e A	358	*/
	359	virtual UClassID getDynamicClassID(void) const;
	360	};
	361
	362	U_NAMESPACE_END
	363
	364	#endif /* #if !UCONFIG_NO_FORMATTING */
	365
340931cb A	366	#endif /* U_SHOW_CPLUSPLUS_API */
340931cb A	367
46f4442e A	368	#endif // RBTZ_H
	369
	370	//eof