CVTzActualisedRules Class Reference

#include <vtzrules.h>

Link against: tzclient.lib

class CVTzActualisedRules : public CBase

Inherits from

Detailed Description

Encapsulates a collection of the local time changes occurring during a range of years.

Constructor & Destructor Documentation

~CVTzActualisedRules ( )

IMPORT_C~CVTzActualisedRules()

Destructor.

Member Function Documentation

AddRuleL ( const TVTzActualisedRule & )

IMPORT_C voidAddRuleL(const TVTzActualisedRule &aRule)

Add an actualised rule to the collection.

Parameters
aRuleAn actualised rule to be added into the collection.

Count ( )

IMPORT_C TIntCount()const

Returns number of rules currently held in array of rules.

Return Value
Number of rules.

EndYear ( )

IMPORT_C TIntEndYear()const

Returns max year of the year range the CVTzActualisedRules object describes the rules for.

Return Value
End year (e.g. 2005).

GetOffsetFromRuleL ( const TTime &, TTzTimeReference )

IMPORT_C TIntGetOffsetFromRuleL(const TTime &aTime,
TTzTimeReferenceaTimeRef
)const

Receives a time. Finds out which of these rules applies at the received time and returns the offset in effect at the specified time.

Leaves with KErrNotFound, if it doesn't find the rule (i.e. aTime is earlier than the very first time in CVTzActualisedRules).

Parameters
aTime- time of interest
aTimeRef- time reference for the aUserTime (UTC or wall-time) note: ETzStdTimeReference for aTimeRef is not supported, will panic with RTz::EPanicUnsupportedTimeReference.
Return Value
TInt - offset from UTC (in minutes).

IsDaylightSavingOn ( TTime & )

IMPORT_C TBoolIsDaylightSavingOn(TTime &aTime)const
Tells if Daylight Savings Applies for the current time zone at the current time
Parameters
aTimeThe time of interest given in UTC.
Return Value
EFalse if Daylight Savings does not apply (winter time) and ETrue if Daylight Savings does apply
Panic Codes
5if aTime is not covered by the current set of time zone rules.
7if one of the time zone rules uses standard time reference.

NewL ( TInt, TInt )

IMPORT_C CVTzActualisedRules *NewL(TIntaStartYear,
TIntaEndYear
)[static]

Factory method for CVTzActualisedRules objects. Creates a new instance of CVTzActualizedRules - an array of actualised rules (TVTzActualisedRule).

The array of rules can be populated later by invoking CTzRules::GetActualisedRulesL() method.

Rules in the array are sorted ascending by rule's start time (TVTzActualisedRule.iTimeOfChange); The very first rule in the array, if present, defines "default standard rule" for the time zone indicating the STD time offset from UTC, in effect from the start of the first year (aStartYear).

Parameters
aEndYear- specify range of years for to which actualised rules apply.
Return Value
A pointer to the newly created rules.
Panic Codes

StartYear ( )

IMPORT_C TIntStartYear()const

Returns min year of the year range the CVTzActualisedRules object describes the rules for. It is guaranteed that the array of rules does not contain any rules for years before that min year.

Return Value
Start year (e.g. 1998).

operator[] ( TInt )

IMPORT_C TVTzActualisedRule &operator[](TIntaIndex)const

Returns specified TVTzActualisedRule.

Parameters
aIndexIndex of a rule
Return Value
A reference to TVTzActualised rule at index aIndex.
Panic Codes