CTzRules Class Reference

#include <vtzrules.h>

Link against: tzclient.lib

class CTzRules : public CBase

Inherits from

CTzRules
- CBase

Public Member Functions
	~CTzRules()
IMPORT_C void	AddRuleL(TTzRule)
IMPORT_C CTzRules *	CloneL()
IMPORT_C TInt	ConvertTime(CVTzActualisedRules &, TTime &, TTzTimeReference)
IMPORT_C void	ConvertToLocalL(TTime &)
IMPORT_C void	ConvertToUtcL(TTime &)
IMPORT_C void	CopyL(const CTzRules &)
IMPORT_C TInt	Count()
IMPORT_C TInt	EndYear()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	GetActualisedRulesL(CVTzActualisedRules &)
IMPORT_C TInt	GetOffsetL(const TTime &, TTzTimeReference)
IMPORT_C TInt	InitialStdTimeOffset()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	IsEqualTo(const CTzRules &)
IMPORT_C CTzRules *	NewL()
IMPORT_C CTzRules *	NewL(TInt, TInt)
IMPORT_C CTzRules *	NewL(RReadStream &)
IMPORT_C void	RemoveRule(TInt)
IMPORT_C TBool	RulesApply(const TTime &)
IMPORT_C void	SetEndYear(TInt)
IMPORT_C void	SetInitialStdTimeOffset(TInt)
IMPORT_C void	SetStartYear(TInt)
IMPORT_C TInt	SizeOfObject()
IMPORT_C TInt	StartYear()
IMPORT_C TTzRule &	operator[](TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Encapsulates a collection of time zone rules, and includes the period covered by the rules and the standard time offset at the start of that period.

Constructor & Destructor Documentation

~CTzRules ( )

IMPORT_C

~CTzRules

(

)

Destructor.

Member Function Documentation

AddRuleL ( TTzRule )

IMPORT_C void

AddRuleL

(

TTzRule

aRule

)

Adds a time zone rule to this set.

Parameters
aRule	The rule to be added.

CloneL ( )

IMPORT_C CTzRules *

CloneL

(

)

const

Creates a copy of these timezone rules.

Return Value: A pointer to the CTzRules copy.

Capability
None

ConvertTime ( CVTzActualisedRules &, TTime &, TTzTimeReference )

IMPORT_C TInt	ConvertTime	(	CVTzActualisedRules &	aRules,
			TTime &	aTime,
			TTzTimeReference	aTimerRef
		)	const

Converts between local (wall-clock) and UTC times.

Parameters
aRules	The actualised rules to use.
aTime	The time to convert, specified by aTimerRef if the time is in UTC or local time. On return, it will contain the converted time from UTC to local time or vice versa, depending on aTimerRef's value.
aTimerRef	What aTime is expressed in.

Return Value: KErrNone if successful, otherwise KErrNotSupported or KErrNotFound

ConvertToLocalL ( TTime & )

IMPORT_C void

ConvertToLocalL

(

TTime &

aUtcTime

)

const

Converts the received UTC time to local time.

Parameters
aUtcTime	The time to convert. On return, this contains the converted time.

ConvertToUtcL ( TTime & )

IMPORT_C void

ConvertToUtcL

(

TTime &

aLocalTime

)

const

Converts the received local time to UTC time.

Parameters
aLocalTime	The time to convert. On return, this contains the converted time.

CopyL ( const CTzRules & )

IMPORT_C void

CopyL

(

const CTzRules &

aTzRule

)

Copy a time zone rule to this time zone rule.

Parameters
aTzRule	A rule to copy from.

Capability
None

Count ( )

IMPORT_C TInt

Count

(

)

const

Gets the number of time zone rules (TTzRules) in this set.

Return Value: The number of rules.

EndYear ( )

IMPORT_C TInt

EndYear

(

)

const

Gets the last year in which the time zone rules apply.

Return Value: The year.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises time zone rules to a write stream.

Parameters
aStream	Stream to which the object should be externalised.

Leave Codes
KErrArgument	if the output stream size is invalid

GetActualisedRulesL ( CVTzActualisedRules & )

IMPORT_C void

GetActualisedRulesL

(

CVTzActualisedRules &

aActRules

)

const

Get actualised rules for time zone rules.

Parameters
aActRules	Actualised rules for time zone rules.

GetOffsetL ( const TTime &, TTzTimeReference )

IMPORT_C TInt	GetOffsetL	(	const TTime &	aTime,
			TTzTimeReference	aTimeRef
		)	const

Calculate the local time offset at the supplied time.

Return Value: local time offset

InitialStdTimeOffset ( )

IMPORT_C TInt

InitialStdTimeOffset

(

)

const

Gets the initial UTC offset for this set of time zone rules.

Return Value: The offset in minutes.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes time zone rules from a read stream.

Parameters
aStream	Stream from which the object should be internalised.

IsEqualTo ( const CTzRules & )

IMPORT_C TBool

IsEqualTo

(

const CTzRules &

aRules

)

const

Compares two sets of timezone rules.

Parameters
aRules	The timezone rules to compare with.

Return Value: ETrue if the rules are identical. EFalse if not.

Capability
None

NewL ( )

IMPORT_C CTzRules *

NewL

(

)

[static]

Creates a new time zone rules object.

Return Value: Pointer to the time zone rules.

NewL ( TInt, TInt )

IMPORT_C CTzRules *	NewL	(	TInt	aStartYear,
			TInt	aEndYear
		)	[static]

Creates a new time zone rules object.

Parameters
aStartYear	The first year in which these time zone rules apply.
aEndYear	The last year in which these time zone rules apply.

Return Value: Pointer to the time zone rules.

NewL ( RReadStream & )

IMPORT_C CTzRules *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new time zone rules object from a stream.

Parameters
aStream	Stream with the time zone rules to be used to create a CTzRules object.

Return Value: Pointer to the time zone rules.

RemoveRule ( TInt )

IMPORT_C void

RemoveRule

(

TInt

aIndex

)

Removes a time zone rule from this set.

Parameters
aIndex	The index of the rule to be removed.

RulesApply ( const TTime & )

IMPORT_C TBool

RulesApply

(

const TTime &

aTime

)

const

Queries the time zone rule set to see if they apply to a specified time.

Parameters
aTime	The time to be checked, using the same time reference used when constructing CTzRules.

Return Value: ETrue if the time zone rules apply to the specified time. EFalse if not.

SetEndYear ( TInt )

IMPORT_C void

SetEndYear

(

TInt

aYear

)

Sets the last year in which the time zone rules apply.

Parameters
aYear	The year.

SetInitialStdTimeOffset ( TInt )

IMPORT_C void

SetInitialStdTimeOffset

(

TInt

aOffset

)

Sets the initial UTC offset for this set of time zone rules.

Parameters
aOffset	The offset in minutes.

SetStartYear ( TInt )

IMPORT_C void

SetStartYear

(

TInt

aYear

)

Sets the first year in which the time zone rules apply.

Parameters
aYear	The year.

SizeOfObject ( )

IMPORT_C TInt

SizeOfObject

(

)

const

Get the object size when it is internalize and externalised.

Return Value: the size of thisobject

StartYear ( )

IMPORT_C TInt

StartYear

(

)

const

Gets the first year in which the time zone rules apply.

Return Value: The year.

operator[] ( TInt )

IMPORT_C TTzRule &

operator[]

(

TInt

aIndex

)

Gets a time zone rule from this set.

Parameters
aIndex	The index of the rule to be fetched.

Return Value: Reference to the time zone rule.