Class TAgnInstanceId

TAgnInstanceId

Support

Supported from 5.0

Description

Identifies an instance of an entry in the agenda instance model (CAgnModel), with an entry ID (TAgnEntryId) and an agenda date (TAgnDate).

Derivation

TAgnEntryId Uniquely identifies an agenda entry in an agenda file TAgnId The base class for agenda entry and to-do list ID types TAgnInstanceId Identifies an instance of an entry in the agenda instance model (CAgnModel), with an entry ID (TAgnEntryId) and an agenda date (TAgnDate)

Defined in TAgnInstanceId:
Date(), ExternalizeL(), InternalizeL(), IsNullInstanceId(), SetDate(), SetIdAndDate(), SetNullInstanceId(), TAgnInstanceId(), operator!=(), operator==()

Inherited from TAgnId:
Id(), IsNullId(), SetNullId(), operator<(), operator>()

TAgnInstanceId();
TAgnInstanceId(TAgnEntryId aId,TAgnDate=AgnDateTime::NullDate());
TAgnInstanceId(TAgnEntryId aId,TTime aDate);

Description

Overloaded C++ constructor. The object can be constructed:

• by default; this sets the entry ID and date to NULL

• with an entry ID and an agenda date

• with an entry ID and a TTime; this initialises the instance ID's date to the date component of the TTime object.

TAgnDate Date() const;

Description

Gets the date of the instance ID.

Return value

TAgnDate The date of the instance ID.

void SetDate(TAgnDate aDate);

Description

Sets the date of the instance ID.

Parameters

TAgnDate aDate The date of the instance ID.

void SetIdAndDate(TAgnEntryId aId,TAgnDate aDate);

Description

Sets both the ID and date.

Parameters

TAgnEntryId aId The entry ID. TAgnDate aDate The date.

void InternalizeL(RReadStream& aStream);

Description

Internalises an instance ID from a read stream. The presence of this function means that the standard templated operator>>() is available to internalise objects of this class.

Parameters

RReadStream& aStream Stream from which the object should be internalized

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises an instance ID to a write stream. The presence of this function means that the standard templated operator<<() is available to externalise objects of this class.

Parameters

RWriteStream& aStream Stream to which the object should be externalised.

TBool operator!=(TAgnInstanceId aId) const;

Description

Compares two instance IDs for inequality.

Parameters

TAgnInstanceId aId The instance ID to compare with this one.

Return value

TBool True if aId is different from this ID. False if they are the same.

TBool operator==(TAgnInstanceId aId) const;

Description

Compares two instance IDs for equality.

Parameters

TAgnInstanceId aId The instance ID to compare with this one.

Return value

TBool True if aId is the same as this ID. False if they are different.

TBool IsNullInstanceId() const;

Description

Tests whether the instance ID is NULL.

Return value

TBool True if the instance ID is NULL, false if not.

void SetNullInstanceId();

Description

Sets the instance ID's date and its entry ID to NULL.