Class CParserPropertyValueMultiDateTime

class CParserPropertyValueMultiDateTime : public CParserTimePropertyValue;

Description

A property value parser which stores a list of date/time values using an array of TVersitDateTime objects.

The UID for a multiple date/time property value is KVersitPropertyMultiDateTimeUid.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CParserPropertyValue - Abstract base class for all property values

• CParserTimePropertyValue - Abstract base class for all of the date/time property value classes

• CParserPropertyValueMultiDateTime - A property value parser which stores a list of date/time values using an array of TVersitDateTime objects

Members

Defined in CParserPropertyValueMultiDateTime:
CParserPropertyValueMultiDateTime(), ConvertAllDateTimesToUTCL(), ConvertAllUTCDateTimesToMachineLocalL(), ExternalizeL(), Value(), iValue, ~CParserPropertyValueMultiDateTime()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CParserPropertyValue:
Append(), EncodeL(), FoldAndWriteValueToStreamL(), FoldEncodeAndWriteValueToStreamL(), IsAsciiCharacterSetSufficient(), PlugIn(), SetPlugIn(), Uid()

Inherited from CParserTimePropertyValue:
ConvertDateTime(), EncodeTimePeriodL(), EncodeVersitDateTimeL(), SupportsInterface()

IMPORT_C CParserPropertyValueMultiDateTime(CArrayPtr< TVersitDateTime > *aValue);

Description

Constructs a multi-date/time property value parser with an array of TVersitDateTimes.

Sets the property value's UID to KVersitPropertyMultiDateTimeUid.

Parameters

CArrayPtr< TVersitDateTime > *aValue Pointer to an array of TVersitDateTime objects, each of which specifies a date/time value, and information about the value. The property value takes ownership of the array.

IMPORT_C ~CParserPropertyValueMultiDateTime();

Description

Frees all resources owned by the property value, prior to its destruction.

inline CArrayPtr< TVersitDateTime > *Value() const;

Description

Gets a pointer to the object's list of date/time property values.

Return value

CArrayPtr< TVersitDateTime > * Pointer to the array of date/time property values.

virtual IMPORT_C void ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &aIncrement, const CVersitDaylight *aDaylight);

Description

Converts each of the date/time values owned by the object into universal time.

Each date/time is checked against the daylight saving information provided in aDaylight. If it falls inside the daylight saving period then the daylight saving offset is subtracted from the time to convert it to universal time. Otherwise aIncrement is added to the date/time of the alarm to convert it to universal time.

Note that the daylight savings offset will adjust the time both for the daylight saving and for the time zone.

The function does not effect any date/time value already stored in universal time.

If aDaylight is a NULL pointer then aIncrement is used.

Parameters

const TTimeIntervalSeconds &aIncrement A time interval in seconds which represents the negative of the time zone of the originating machine. For instance, if the time zone is +04:30 (that is 4hr 30mins ahead of UTC), aIncrement should be set to minus the number of seconds in 4hr 30mins. const CVersitDaylight *aDaylight Pointer to the specification for daylight saving. If the time value is within the period for daylight saving, the value is modified by the daylight saving offset (which accounts for both the time zone and daylight saving rule).

virtual IMPORT_C void ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &aIncrement);

Description

Converts the date/time property values into machine-local time.

This process involves adjusting the date/time values by the offset in aIncrement.

The function has no effect on any values already stored in machine-local time.

Parameters

const TTimeIntervalSeconds &aIncrement A time interval which represents the number of seconds which is to be added to the date/time values. This should normally be the universal time offset for the machine's locale.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream, const Versit::TEncodingAndCharset &,TInt aLengthOutput);

Description

Externalises the array of date/time property values into aStream.

Parameters

RWriteStream &aStream const Versit::TEncodingAndCharset & TInt aLengthOutput

protected: CArrayPtr< TVersitDateTime > * iValue;

Description