Symbian^3 Product Developer Library >

TAgnCalendarTime Class Reference

class TAgnCalendarTime

The main time class for use within Calendar. This stores either a fixed or floating time - a fixed time is stored as UTC, a floating time is stored as local. The offset between UTC and local is cached and updated when necessary.

This class should be used as widely as possible throughout Calendar, eventually replacing the less useful TTime. TCalTime is an equivalent class to TAgnCalendarTime, but is exposed in the Calendar API.

Public Member Functions
TAgnCalendarTime()
const MAgnCalendarTimeMode *CalendarTimeMode()
TInt Compare(const TAgnCalendarTime &, const TAgnCalendarTime &)
TBool CompareTimeArrays(const RArray< TAgnCalendarTime > *, const RArray< TAgnCalendarTime > *)
voidExternalizeL(RWriteStream &)
voidExternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RWriteStream &)
voidInsertInOrderL(RArray< TAgnCalendarTime > &, const TAgnCalendarTime &)
IMPORT_C voidInternalizeL(RReadStream &)
voidInternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RReadStream &)
IMPORT_C TBoolIsSet()
IMPORT_C TBoolIsValidTime()
IMPORT_C TTimeLocalL()
IMPORT_C voidSetFloatingL(const TTime &)
IMPORT_C voidSetLocalL(const TTime &)
voidSetNull()
IMPORT_C voidSetUtcL(const TTime &)
IMPORT_C MAgnCalendarTimeMode::TTimeModeTimeMode()
IMPORT_C TTimeUtcL()
IMPORT_C TBooloperator!=(const TAgnCalendarTime &)
IMPORT_C TBooloperator<(const TAgnCalendarTime &)
IMPORT_C TBooloperator<=(const TAgnCalendarTime &)
IMPORT_C TBooloperator==(const TAgnCalendarTime &)
IMPORT_C TBooloperator>(const TAgnCalendarTime &)
IMPORT_C TBooloperator>=(const TAgnCalendarTime &)
Private Member Functions
TTime DateTimeL(MAgnCalendarTimeMode::TFormat)
voidSetDateTimeL(const TTime &, TBool, MAgnCalendarTimeMode::TFormat)
voidSetFloatingFlag(TBool)
voidSetTzId(TUint16)
voidStoreNewOffset(const TTime &)
CAgnTlsProxy *TimeZoneAccessor()
TUint16 TzId()
Private Attributes
TInt16 iLocalOffsetInMinutes
TTime iTime
CAgnTlsProxy *iTimeZoneAccessor
TUint16 iTzId

Constructor & Destructor Documentation

TAgnCalendarTime()

IMPORT_CTAgnCalendarTime()

Member Functions Documentation

CalendarTimeMode()

const MAgnCalendarTimeMode *CalendarTimeMode()const

Compare(const TAgnCalendarTime &, const TAgnCalendarTime &)

TInt Compare(const TAgnCalendarTime &aLeft,
const TAgnCalendarTime &aRight
)[static]

Parameters

const TAgnCalendarTime & aLeft
const TAgnCalendarTime & aRight

CompareTimeArrays(const RArray< TAgnCalendarTime > *, const RArray< TAgnCalendarTime > *)

TBool CompareTimeArrays(const RArray< TAgnCalendarTime > *aLeft,
const RArray< TAgnCalendarTime > *aRight
)[static]

Parameters

const RArray< TAgnCalendarTime > * aLeft
const RArray< TAgnCalendarTime > * aRight

DateTimeL(MAgnCalendarTimeMode::TFormat)

TTime DateTimeL(MAgnCalendarTimeMode::TFormataFormat)const [private]

Parameters

MAgnCalendarTimeMode::TFormat aFormat

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

ExternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RWriteStream &)

voidExternalizeTimeArrayL(RArray< TAgnCalendarTime > &aArray,
RWriteStream &aStream
)[static]

Parameters

RArray< TAgnCalendarTime > & aArray
RWriteStream & aStream

InsertInOrderL(RArray< TAgnCalendarTime > &, const TAgnCalendarTime &)

voidInsertInOrderL(RArray< TAgnCalendarTime > &aTimeArray,
const TAgnCalendarTime &aTimeToInsert
)[static]

Parameters

RArray< TAgnCalendarTime > & aTimeArray
const TAgnCalendarTime & aTimeToInsert

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

InternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RReadStream &)

voidInternalizeTimeArrayL(RArray< TAgnCalendarTime > &aArray,
RReadStream &aStream
)[static]

Parameters

RArray< TAgnCalendarTime > & aArray
RReadStream & aStream

IsSet()

IMPORT_C TBoolIsSet()const

IsValidTime()

IMPORT_C TBoolIsValidTime()const

LocalL()

IMPORT_C TTimeLocalL()const

SetDateTimeL(const TTime &, TBool, MAgnCalendarTimeMode::TFormat)

voidSetDateTimeL(const TTime &aTime,
TBoolaFloating,
MAgnCalendarTimeMode::TFormataFormat = MAgnCalendarTimeMode::EUtc
)[private]

Set the time and time mode of the AgnCalendarTime

Parameters

const TTime & aTimeThe time to be stored, can be UTC if aFormat is EUtc, or local if aFormat is ELocal or EFixedLocal
TBool aFloating
MAgnCalendarTimeMode::TFormat aFormat = MAgnCalendarTimeMode::EUtcThe time format of aTime

SetFloatingFlag(TBool)

voidSetFloatingFlag(TBoolaFloating)const [private]

Parameters

TBool aFloating

SetFloatingL(const TTime &)

IMPORT_C voidSetFloatingL(const TTime &aTime)

Parameters

const TTime & aTime

SetLocalL(const TTime &)

IMPORT_C voidSetLocalL(const TTime &aTime)

Parameters

const TTime & aTime

SetNull()

voidSetNull()

SetTzId(TUint16)

voidSetTzId(TUint16aTzId)const [private]

Parameters

TUint16 aTzId

SetUtcL(const TTime &)

IMPORT_C voidSetUtcL(const TTime &aTime)

Parameters

const TTime & aTime

StoreNewOffset(const TTime &)

voidStoreNewOffset(const TTime &aTime)const [private]

Parameters

const TTime & aTime

TimeMode()

IMPORT_C MAgnCalendarTimeMode::TTimeModeTimeMode()const

TimeZoneAccessor()

CAgnTlsProxy *TimeZoneAccessor()const [private]

TzId()

TUint16 TzId()const [private]

UtcL()

IMPORT_C TTimeUtcL()const

operator!=(const TAgnCalendarTime &)

IMPORT_C TBooloperator!=(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

operator<(const TAgnCalendarTime &)

IMPORT_C TBooloperator<(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

operator<=(const TAgnCalendarTime &)

IMPORT_C TBooloperator<=(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

operator==(const TAgnCalendarTime &)

IMPORT_C TBooloperator==(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

operator>(const TAgnCalendarTime &)

IMPORT_C TBooloperator>(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

operator>=(const TAgnCalendarTime &)

IMPORT_C TBooloperator>=(const TAgnCalendarTime &aTime)const

Parameters

const TAgnCalendarTime & aTime

Member Data Documentation

TInt16 iLocalOffsetInMinutes

TInt16 iLocalOffsetInMinutes[private]

TTime iTime

TTime iTime[private]

CAgnTlsProxy * iTimeZoneAccessor

CAgnTlsProxy *iTimeZoneAccessor[private]

TUint16 iTzId

TUint16 iTzId[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.