Class TSwizzleCBase

class TSwizzleCBase;

Description

Base class for swizzles.

A swizzle maintains a dual representation for an object:

by stream id, if the object is not in memory (the stream contains the external representation of that object).

by pointer, if the object is in memory.

The class is not intended for instantiation.

Members

Defined in TSwizzleCBase:

• AsId()constGets the streamid of the represented object.
• DoExternalizeL(RWriteStream &,TExternalizer< TAny >)const
• InternalizeL(RReadStream &)Internalises a stream id from the read stream, constructs a swizzle from this st...
• IsId()constTests whether this swizzle currently represents an object as a stream id.
• IsPtr()constTests whether this swizzle currently represents an object as a pointer.
• Ptr()const
• TSwizzleCBase()
• TSwizzleCBase(TStreamId)
• TSwizzleCBase(TStreamRef)
• TSwizzleCBase(const TAny *)
• operator!=(const TAny *)constCompares for inequality with an in-memory object.
• operator!=(const TSwizzleCBase &)constCompares for inequality with another swizzle.
• operator==(const TAny *)constCompares for equality with an in-memory object.
• operator==(const TSwizzleCBase &)constCompares for equality with another swizzle.

protected: inline TSwizzleCBase();

Description

protected: inline TSwizzleCBase(const TAny *aPtr);

Description

Parameters

protected: IMPORT_C TSwizzleCBase(TStreamId anId);

Description

Parameters

protected: inline TSwizzleCBase(TStreamRef aRef);

Description

Parameters

inline TBool operator==(const TSwizzleCBase &aSwizzle) const;

Description

Compares for equality with another swizzle.

Use this operator to determine whether this swizzle represents the same object as that represented by the specified swizzle.

Both this swizzle and the specified swizzle must maintain the representation of their respective objects as either pointers or stream ids.

If one swizzle maintains the representation of its object as a pointer while the other swizzle maintains the representation of its object as a stream id, the comparison is meaningless and always returns false.

Parameters

Return value

inline TBool operator==(const TAny *aPtr) const;

Description

Compares for equality with an in-memory object.

Use this operator to determine whether this swizzle represents the same in-memory object as that represented by the specified pointer.

This swizzle must maintain the representation of its object as a pointer. If it maintains the representation of its object as a swizzle, the comparison is meaningless and always returns false.

Parameters

Return value

inline TBool operator!=(const TSwizzleCBase &aSwizzle) const;

Description

Compares for inequality with another swizzle.

Use this operator to determine whether this swizzle represents a different object to that represented by the specified swizzle.

Both this swizzle and the specified swizzle must maintain the representation of their respective objects as either pointers or stream ids.

If one swizzle maintains the representation of its object as a pointer while the other swizzle maintains the representation of its object as a stream id, the comparison is meaningless and always returns true.

Parameters

Return value

inline TBool operator!=(const TAny *aPtr) const;

Description

Compares for inequality with an in-memory object.

Use this operator to determine whether this swizzle represents a different in-memory object to that represented by the specified pointer.

This swizzle must maintain the representation of its object as a pointer. If it maintains the representation of its object as a swizzle, the comparison is meaningless and always returns true.

Parameters

Return value

inline TBool IsPtr() const;

Description

Tests whether this swizzle currently represents an object as a pointer.

Return value

inline TBool IsId() const;

Description

Tests whether this swizzle currently represents an object as a stream id.

Return value

IMPORT_C TStreamId AsId() const;

Description

Gets the streamid of the represented object.

This swizzle must currently represent the object as a stream id, otherwise the function raises a STORE-Store 3 panic.

Return value

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a stream id from the read stream, constructs a swizzle from this stream id and copies the swizzle to this swizzle.

The presence of this function means that the standard templated operator>>(RReadStream &,T &) can be used to internalise objects of this class.

Parameters

protected: inline const TAny* Ptr() const;

Description

Return value

protected: IMPORT_C void DoExternalizeL(RWriteStream &aStream, TExternalizer< TAny > anExter) const;

Description

Parameters