ICU 60.1  60.1
Public Member Functions | Static Public Member Functions
icu::TimeArrayTimeZoneRule Class Reference

TimeArrayTimeZoneRule represents a time zone rule whose start times are defined by an array of milliseconds since the standard base time. More...

#include <tzrule.h>

Inheritance diagram for icu::TimeArrayTimeZoneRule:
icu::TimeZoneRule icu::UObject icu::UMemory

Public Member Functions

 TimeArrayTimeZoneRule (const UnicodeString &name, int32_t rawOffset, int32_t dstSavings, const UDate *startTimes, int32_t numStartTimes, DateTimeRule::TimeRuleType timeRuleType)
 Constructs a TimeArrayTimeZoneRule with the name, the GMT offset of its standard time, the amount of daylight saving offset adjustment and the array of times when this rule takes effect. More...
 
 TimeArrayTimeZoneRule (const TimeArrayTimeZoneRule &source)
 Copy constructor. More...
 
virtual ~TimeArrayTimeZoneRule ()
 Destructor. More...
 
virtual TimeArrayTimeZoneRuleclone (void) const
 Clone this TimeArrayTimeZoneRule object polymorphically. More...
 
TimeArrayTimeZoneRuleoperator= (const TimeArrayTimeZoneRule &right)
 Assignment operator. More...
 
virtual UBool operator== (const TimeZoneRule &that) const
 Return true if the given TimeZoneRule objects are semantically equal. More...
 
virtual UBool operator!= (const TimeZoneRule &that) const
 Return true if the given TimeZoneRule objects are semantically unequal. More...
 
DateTimeRule::TimeRuleType getTimeType (void) const
 Gets the time type of the start times used by this rule. More...
 
UBool getStartTimeAt (int32_t index, UDate &result) const
 Gets a start time at the index stored in this rule. More...
 
int32_t countStartTimes (void) const
 Returns the number of start times stored in this rule. More...
 
virtual UBool isEquivalentTo (const TimeZoneRule &that) const
 Returns if this rule represents the same rule and offsets as another. More...
 
virtual UBool getFirstStart (int32_t prevRawOffset, int32_t prevDSTSavings, UDate &result) const
 Gets the very first time when this rule takes effect. More...
 
virtual UBool getFinalStart (int32_t prevRawOffset, int32_t prevDSTSavings, UDate &result) const
 Gets the final time when this rule takes effect. More...
 
virtual UBool getNextStart (UDate base, int32_t prevRawOffset, int32_t prevDSTSavings, UBool inclusive, UDate &result) const
 Gets the first time when this rule takes effect after the specified time. More...
 
virtual UBool getPreviousStart (UDate base, int32_t prevRawOffset, int32_t prevDSTSavings, UBool inclusive, UDate &result) const
 Gets the most recent time when this rule takes effect before the specified time. More...
 
virtual UClassID getDynamicClassID (void) const
 Returns a unique class ID POLYMORPHICALLY. More...
 
- Public Member Functions inherited from icu::TimeZoneRule
virtual ~TimeZoneRule ()
 Destructor. More...
 
UnicodeStringgetName (UnicodeString &name) const
 Fills in "name" with the name of this time zone. More...
 
int32_t getRawOffset (void) const
 Gets the standard time offset. More...
 
int32_t getDSTSavings (void) const
 Gets the amount of daylight saving delta time from the standard time. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from icu::TimeZoneRule
 TimeZoneRule (const UnicodeString &name, int32_t rawOffset, int32_t dstSavings)
 Constructs a TimeZoneRule with the name, the GMT offset of its standard time and the amount of daylight saving offset adjustment. More...
 
 TimeZoneRule (const TimeZoneRule &source)
 Copy constructor. More...
 
TimeZoneRuleoperator= (const TimeZoneRule &right)
 Assignment operator. More...
 

Detailed Description

TimeArrayTimeZoneRule represents a time zone rule whose start times are defined by an array of milliseconds since the standard base time.

Stable:
ICU 3.8

Definition at line 618 of file tzrule.h.

Constructor & Destructor Documentation

◆ TimeArrayTimeZoneRule() [1/2]

icu::TimeArrayTimeZoneRule::TimeArrayTimeZoneRule ( const UnicodeString name,
int32_t  rawOffset,
int32_t  dstSavings,
const UDate startTimes,
int32_t  numStartTimes,
DateTimeRule::TimeRuleType  timeRuleType 
)

Constructs a TimeArrayTimeZoneRule with the name, the GMT offset of its standard time, the amount of daylight saving offset adjustment and the array of times when this rule takes effect.

Parameters
nameThe time zone name.
rawOffsetThe UTC offset of its standard time in milliseconds.
dstSavingsThe amount of daylight saving offset adjustment in milliseconds. If this ia a rule for standard time, the value of this argument is 0.
startTimesThe array start times in milliseconds since the base time (January 1, 1970, 00:00:00).
numStartTimesThe number of elements in the parameter "startTimes"
timeRuleTypeThe time type of the start times, which is one of DataTimeRule::WALL_TIME, STANDARD_TIME and UTC_TIME.
Stable:
ICU 3.8

◆ TimeArrayTimeZoneRule() [2/2]

icu::TimeArrayTimeZoneRule::TimeArrayTimeZoneRule ( const TimeArrayTimeZoneRule source)

Copy constructor.

Parameters
sourceThe TimeArrayTimeZoneRule object to be copied.
Stable:
ICU 3.8

◆ ~TimeArrayTimeZoneRule()

virtual icu::TimeArrayTimeZoneRule::~TimeArrayTimeZoneRule ( )
virtual

Destructor.

Stable:
ICU 3.8

Member Function Documentation

◆ clone()

virtual TimeArrayTimeZoneRule* icu::TimeArrayTimeZoneRule::clone ( void  ) const
virtual

Clone this TimeArrayTimeZoneRule object polymorphically.

The caller owns the result and should delete it when done.

Returns
A copy of the object.
Stable:
ICU 3.8

Implements icu::TimeZoneRule.

◆ countStartTimes()

int32_t icu::TimeArrayTimeZoneRule::countStartTimes ( void  ) const

Returns the number of start times stored in this rule.

Returns
The number of start times.
Stable:
ICU 3.8

◆ getDynamicClassID()

virtual UClassID icu::TimeArrayTimeZoneRule::getDynamicClassID ( void  ) const
virtual

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.

Returns
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

Reimplemented from icu::UObject.

◆ getFinalStart()

virtual UBool icu::TimeArrayTimeZoneRule::getFinalStart ( int32_t  prevRawOffset,
int32_t  prevDSTSavings,
UDate result 
) const
virtual

Gets the final time when this rule takes effect.

Parameters
prevRawOffsetThe standard time offset from UTC before this rule takes effect in milliseconds.
prevDSTSavingsThe amount of daylight saving offset from the standard time.
resultReceives the final time when this rule takes effect.
Returns
true if the start time is available. When false is returned, output parameter "result" is unchanged.
Stable:
ICU 3.8

Implements icu::TimeZoneRule.

◆ getFirstStart()

virtual UBool icu::TimeArrayTimeZoneRule::getFirstStart ( int32_t  prevRawOffset,
int32_t  prevDSTSavings,
UDate result 
) const
virtual

Gets the very first time when this rule takes effect.

Parameters
prevRawOffsetThe standard time offset from UTC before this rule takes effect in milliseconds.
prevDSTSavingsThe amount of daylight saving offset from the standard time.
resultReceives the very first time when this rule takes effect.
Returns
true if the start time is available. When false is returned, output parameter "result" is unchanged.
Stable:
ICU 3.8

Implements icu::TimeZoneRule.

◆ getNextStart()

virtual UBool icu::TimeArrayTimeZoneRule::getNextStart ( UDate  base,
int32_t  prevRawOffset,
int32_t  prevDSTSavings,
UBool  inclusive,
UDate result 
) const
virtual

Gets the first time when this rule takes effect after the specified time.

Parameters
baseThe first start time after this base time will be returned.
prevRawOffsetThe standard time offset from UTC before this rule takes effect in milliseconds.
prevDSTSavingsThe amount of daylight saving offset from the standard time.
inclusiveWhether the base time is inclusive or not.
resultReceives The first time when this rule takes effect after the specified base time.
Returns
true if the start time is available. When false is returned, output parameter "result" is unchanged.
Stable:
ICU 3.8

Implements icu::TimeZoneRule.

◆ getPreviousStart()

virtual UBool icu::TimeArrayTimeZoneRule::getPreviousStart ( UDate  base,
int32_t  prevRawOffset,
int32_t  prevDSTSavings,
UBool  inclusive,
UDate result 
) const
virtual

Gets the most recent time when this rule takes effect before the specified time.

Parameters
baseThe most recent time before this base time will be returned.
prevRawOffsetThe standard time offset from UTC before this rule takes effect in milliseconds.
prevDSTSavingsThe amount of daylight saving offset from the standard time.
inclusiveWhether the base time is inclusive or not.
resultReceives The most recent time when this rule takes effect before the specified base time.
Returns
true if the start time is available. When false is returned, output parameter "result" is unchanged.
Stable:
ICU 3.8

Implements icu::TimeZoneRule.

◆ getStartTimeAt()

UBool icu::TimeArrayTimeZoneRule::getStartTimeAt ( int32_t  index,
UDate result 
) const

Gets a start time at the index stored in this rule.

Parameters
indexThe index of start times
resultReceives the start time at the index
Returns
true if the index is within the valid range and and the result is set. When false, the output parameger "result" is unchanged.
Stable:
ICU 3.8

◆ getStaticClassID()

static UClassID icu::TimeArrayTimeZoneRule::getStaticClassID ( void  )
static

Return the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

.   Base* polymorphic_pointer = createPolymorphicObject();
.   if (polymorphic_pointer->getDynamicClassID() ==
.       erived::getStaticClassID()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 3.8

◆ getTimeType()

DateTimeRule::TimeRuleType icu::TimeArrayTimeZoneRule::getTimeType ( void  ) const

Gets the time type of the start times used by this rule.

The return value is either DateTimeRule::WALL_TIME or STANDARD_TIME or UTC_TIME.

Returns
The time type used of the start times used by this rule.
Stable:
ICU 3.8

◆ isEquivalentTo()

virtual UBool icu::TimeArrayTimeZoneRule::isEquivalentTo ( const TimeZoneRule that) const
virtual

Returns if this rule represents the same rule and offsets as another.

When two TimeZoneRule objects differ only its names, this method returns true.

Parameters
thatThe TimeZoneRule object to be compared with.
Returns
true if the other TimeZoneRule is equivalent to this one.
Stable:
ICU 3.8

Reimplemented from icu::TimeZoneRule.

◆ operator!=()

virtual UBool icu::TimeArrayTimeZoneRule::operator!= ( const TimeZoneRule that) const
virtual

Return true if the given TimeZoneRule objects are semantically unequal.

Objects of different subclasses are considered unequal.

Parameters
thatThe object to be compared with.
Returns
true if the given TimeZoneRule objects are semantically unequal.
Stable:
ICU 3.8

Reimplemented from icu::TimeZoneRule.

◆ operator=()

TimeArrayTimeZoneRule& icu::TimeArrayTimeZoneRule::operator= ( const TimeArrayTimeZoneRule right)

Assignment operator.

Parameters
rightThe object to be copied.
Stable:
ICU 3.8

◆ operator==()

virtual UBool icu::TimeArrayTimeZoneRule::operator== ( const TimeZoneRule that) const
virtual

Return true if the given TimeZoneRule objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters
thatThe object to be compared with.
Returns
true if the given TimeZoneRule objects are semantically equal.
Stable:
ICU 3.8

Reimplemented from icu::TimeZoneRule.


The documentation for this class was generated from the following file: