TTzRule Class Reference

#include <mw/vtzrules.h>

Link against: tzclient.lib

class TTzRule

Public Attributes
TUint8	iDayOfMonth
TUint8	iDayOfWeek
TTzRuleDay	iDayRule
TTimeWithReference	iFrom
TMonth	iMonth
TInt16	iNewLocalTimeOffset
TInt16	iOldLocalTimeOffset
TUint32	iReserved
TUint16	iTimeOfChange
TTzTimeReference	iTimeReference
TTimeWithReference	iTo

Public Member Functions
	TTzRule(TInt16, TInt16, TInt16, TInt16, TMonth, TTzRuleDay, TUint8, TUint8, TTzTimeReference, TUint16)
	TTzRule()
	TTzRule(const TTzRule &)
	TTzRule(TTimeWithReference, TTimeWithReference, TInt16, TInt16, TMonth, TTzRuleDay, TUint8, TUint8, TTzTimeReference, TUint16)
IMPORT_C TVTzActualisedRule	Actualise(TInt)
IMPORT_C TVTzActualisedRule	ActualiseL(TInt)
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
TBool	RuleApplies(const TTime &, const TTime &)

Detailed Description

Encapsulates one time zone rule.

Member Attribute Documentation

iDayOfMonth

TUint8

iDayOfMonth

iDayOfWeek

TUint8

iDayOfWeek

iDayRule

TTzRuleDay

iDayRule

iFrom

TTimeWithReference

iFrom

iMonth

TMonth

iMonth

iNewLocalTimeOffset

TInt16

iNewLocalTimeOffset

iOldLocalTimeOffset

TInt16

iOldLocalTimeOffset

iReserved

TUint32

iReserved

iTimeOfChange

TUint16

iTimeOfChange

iTimeReference

TTzTimeReference

iTimeReference

iTo

TTimeWithReference

iTo

Constructor & Destructor Documentation

TTzRule ( TInt16, TInt16, TInt16, TInt16, TMonth, TTzRuleDay, TUint8, TUint8, TTzTimeReference, TUint16 )

IMPORT_C	TTzRule	(	TInt16	aFromYear,
			TInt16	aToYear,
			TInt16	aOldOffset,
			TInt16	aNewOffset,
			TMonth	aMonth,
			TTzRuleDay	aDayRule,
			TUint8	aDayOfMonth,
			TUint8	aDayOfWeek,
			TTzTimeReference	aTimeReference,
			TUint16	aTimeOfChange
		)

Constructor for a time zone rule.

Parameter	Description
aFromYear	The first year in which the rule applies.
aToYear	The last year in which the rule applies.
aOldOffset	The UTC offset in minutes which applies before the DST change.
aNewOffset	The UTC offset in minutes which applies after the DST change.
aMonth	The month in which the DST change occurs.
aDayRule	The rule defining on which day the DST change takes place.
aDayOfMonth	The number of the day within the month, offset from zero. Used in conjunction with aDayRule to define the day where DST changes.
aDayOfWeek	The number of the day within the week, the numerical equivalent of a TDay value. Used in conjunction with aDayRule to define the day where DST changes.
aTimeReference	Defines whether aTimeOfChange is a local (wall-clock) time or a UTC time.
aTimeOfChange	The time of the DST change in minutes from midnight.

TTzRule ( )

IMPORT_C

TTzRule

(

)

Default constructor for a time zone rule.

All member variables are set to zero values.

TTzRule ( const TTzRule & )

IMPORT_C

TTzRule

(

const TTzRule &

aRule

)

Copy constructor for a time zone rule.

TTzRule ( TTimeWithReference, TTimeWithReference, TInt16, TInt16, TMonth, TTzRuleDay, TUint8, TUint8, TTzTimeReference, TUint16 )

IMPORT_C	TTzRule	(	TTimeWithReference	aFromYear,
			TTimeWithReference	aToYear,
			TInt16	aOldOffset,
			TInt16	aNewOffset,
			TMonth	aMonth,
			TTzRuleDay	aDayRule,
			TUint8	aDayOfMonth,
			TUint8	aDayOfWeek,
			TTzTimeReference	aTimeReference,
			TUint16	aTimeOfChange
		)

Constructor for a time zone rule.

Parameter	Description
aFromYear	The first date at which the rule applies.
aToYear	The last date at which the rule applies.
aOldOffset	The UTC offset in minutes which applies before the DST change.
aNewOffset	The UTC offset in minutes which applies after the DST change.
aMonth	The month in which the DST change occurs.
aDayRule	The rule defining on which day the DST change takes place.
aDayOfMonth	The number of the day within the month, offset from zero. Used in conjunction with aDayRule to define the day when DST changes.
aDayOfWeek	The number of the day within the week, the numerical equivalent of a TDay value. Used in conjunction with aDayRule to define the day where DST changes.
aTimeReference	Defines whether aTimeOfChange is a local (wall-clock) time or a UTC time.
aTimeOfChange	The time of the DST change in minutes from midnight.

Member Function Documentation

Actualise ( TInt )

IMPORT_C TVTzActualisedRule

Actualise

(

TInt

aYear

)

const

Resolves the date rule to the precise date and time for the given year, and returns it in a TVTzActualisedRule

For day rules ETzDayAfterDate & ETzDayBeforeDate, the reference date entered is inclusive in the calculation. ie. If the reference date fits the criteria, the reference date will be returned.

eg. Actualise(Friday, ETzDayAfterDate, Fri Jun 22, 2007) returns Jun 22, 2007.

Deprecated. Use TVTzActualisedRule TTzRule::ActualiseL instead.

Deprecated

Parameter	Description
aYear	Year to actualise time rules

Returns: The time zone rule with the precise date and time for the given year.

ActualiseL ( TInt )

IMPORT_C TVTzActualisedRule

ActualiseL

(

TInt

aYear

)

const

Resolves the date rule to the precise date and time for the given year, and returns it in a TVTzActualisedRule

For day rules ETzDayAfterDate & ETzDayBeforeDate, the reference date entered is inclusive in the calculation. ie. If the reference date fits the criteria, the reference date will be returned.

eg. Actualise(Friday, ETzDayAfterDate, Fri Jun 22, 2007) returns Jun 22, 2007.

leave: KErrCorrupt if the current day rule is not one of the defined values in TTzRuleDay

Parameter	Description
aYear	Year to actualise time rules

Returns: The time zone rule with the precise date and time for the given year.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a time zone rule to a write stream.

Parameter	Description
aStream	Stream to which the object should be externalised.

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Internalizes a time zone rule from a read stream.

Parameter	Description
aStream	Stream from which the object should be internalised.

RuleApplies ( const TTime &, const TTime & )

TBool	RuleApplies	(	const TTime &	aStart,
			const TTime &	aEnd
		)	const

Check if a time zone rule is applicable during a time range.

Parameter	Description
aStart	Start of time range, inclusively. ie. For a rule to be applicable, this time can be equal to or earlier than the rule's end time. This time should use the same time reference used when TTzRule is constructed.
aEnd	End of time range, exclusively. ie. In order for a rule to be applicable, this time must be later than the rule's start time. This time should use the same time reference used when TTzRule is constructed.

Returns: ETrue if the rule applies during the supplied time range, EFalse otherwise.