Symbian^3 Application 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 > *)
void ExternalizeL ( RWriteStream &)
void ExternalizeTimeArrayL ( RArray < TAgnCalendarTime > &, RWriteStream &)
void InsertInOrderL ( RArray < TAgnCalendarTime > &, const TAgnCalendarTime &)
IMPORT_C void InternalizeL ( RReadStream &)
void InternalizeTimeArrayL ( RArray < TAgnCalendarTime > &, RReadStream &)
IMPORT_C TBool IsSet ()
IMPORT_C TBool IsValidTime ()
IMPORT_C TTime LocalL ()
IMPORT_C void SetFloatingL (const TTime &)
IMPORT_C void SetLocalL (const TTime &)
void SetNull ()
IMPORT_C void SetUtcL (const TTime &)
IMPORT_C MAgnCalendarTimeMode::TTimeMode TimeMode ()
IMPORT_C TTime UtcL ()
IMPORT_C TBool operator!= (const TAgnCalendarTime &)
IMPORT_C TBool operator< (const TAgnCalendarTime &)
IMPORT_C TBool operator<= (const TAgnCalendarTime &)
IMPORT_C TBool operator== (const TAgnCalendarTime &)
IMPORT_C TBool operator> (const TAgnCalendarTime &)
IMPORT_C TBool operator>= (const TAgnCalendarTime &)
Private Member Functions
TTime DateTimeL ( MAgnCalendarTimeMode::TFormat )
void SetDateTimeL (const TTime &, TBool , MAgnCalendarTimeMode::TFormat )
void SetFloatingFlag ( TBool )
void SetTzId ( TUint16 )
void StoreNewOffset (const TTime &)
CAgnTlsProxy * TimeZoneAccessor ()
TUint16 TzId ()
Private Attributes
TInt16 iLocalOffsetInMinutes
TTime iTime
CAgnTlsProxy * iTimeZoneAccessor
TUint16 iTzId

Constructor & Destructor Documentation

TAgnCalendarTime()

IMPORT_C TAgnCalendarTime ( )

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::TFormat aFormat ) const [private]

Parameters

MAgnCalendarTimeMode::TFormat aFormat

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const

Parameters

RWriteStream & aStream

ExternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RWriteStream &)

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

Parameters

RArray < TAgnCalendarTime > & aArray
RWriteStream & aStream

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

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

Parameters

RArray < TAgnCalendarTime > & aTimeArray
const TAgnCalendarTime & aTimeToInsert

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Parameters

RReadStream & aStream

InternalizeTimeArrayL(RArray< TAgnCalendarTime > &, RReadStream &)

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

Parameters

RArray < TAgnCalendarTime > & aArray
RReadStream & aStream

IsSet()

IMPORT_C TBool IsSet ( ) const

IsValidTime()

IMPORT_C TBool IsValidTime ( ) const

LocalL()

IMPORT_C TTime LocalL ( ) const

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

void SetDateTimeL ( const TTime & aTime,
TBool aFloating,
MAgnCalendarTimeMode::TFormat aFormat = MAgnCalendarTimeMode::EUtc
) [private]

Set the time and time mode of the AgnCalendarTime

Parameters

const TTime & aTime The 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::EUtc The time format of aTime

SetFloatingFlag(TBool)

void SetFloatingFlag ( TBool aFloating ) const [private]

Parameters

TBool aFloating

SetFloatingL(const TTime &)

IMPORT_C void SetFloatingL ( const TTime & aTime )

Parameters

const TTime & aTime

SetLocalL(const TTime &)

IMPORT_C void SetLocalL ( const TTime & aTime )

Parameters

const TTime & aTime

SetNull()

void SetNull ( )

SetTzId(TUint16)

void SetTzId ( TUint16 aTzId ) const [private]

Parameters

TUint16 aTzId

SetUtcL(const TTime &)

IMPORT_C void SetUtcL ( const TTime & aTime )

Parameters

const TTime & aTime

StoreNewOffset(const TTime &)

void StoreNewOffset ( const TTime & aTime ) const [private]

Parameters

const TTime & aTime

TimeMode()

IMPORT_C MAgnCalendarTimeMode::TTimeMode TimeMode ( ) const

TimeZoneAccessor()

CAgnTlsProxy * TimeZoneAccessor ( ) const [private]

TzId()

TUint16 TzId ( ) const [private]

UtcL()

IMPORT_C TTime UtcL ( ) const

operator!=(const TAgnCalendarTime &)

IMPORT_C TBool operator!= ( const TAgnCalendarTime & aTime ) const

Parameters

const TAgnCalendarTime & aTime

operator<(const TAgnCalendarTime &)

IMPORT_C TBool operator< ( const TAgnCalendarTime & aTime ) const

Parameters

const TAgnCalendarTime & aTime

operator<=(const TAgnCalendarTime &)

IMPORT_C TBool operator<= ( const TAgnCalendarTime & aTime ) const

Parameters

const TAgnCalendarTime & aTime

operator==(const TAgnCalendarTime &)

IMPORT_C TBool operator== ( const TAgnCalendarTime & aTime ) const

Parameters

const TAgnCalendarTime & aTime

operator>(const TAgnCalendarTime &)

IMPORT_C TBool operator> ( const TAgnCalendarTime & aTime ) const

Parameters

const TAgnCalendarTime & aTime

operator>=(const TAgnCalendarTime &)

IMPORT_C TBool operator>= ( 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.