Class TSglQueBase

class TSglQueBase;

Description

A base class that provides implementation for the singly linked list header.

It also encapsulates the offset value of a link object.

The class is abstract and is not intended to be instantiated.

Members

Defined in TSglQueBase:

• DoAddFirst(TAny *)Implements the insertion of a list element at the front of the singly linked lis...
• DoAddLast(TAny *)
• DoRemove(TAny *)
• IsEmpty()constTests whether the singly linked list is empty, i.e. has no list elements.
• Reset()Empties the singly linked list.
• SetOffset(TInt)Sets the offset of the link object from the start of a singly linked list elemen...
• TSglQueBase()Default constructor.
• TSglQueBase(TInt)
• iElements
• iHead
• iHeadA pointer to the first element in the list.
• iLast
• iLastA pointer to the last element in the list.
• iOffsetThe offset of a component link object within elements that form the list.

See also:

• TSglQueA templated class that provides the behaviour for managing a singly linked list.

protected: IMPORT_C TSglQueBase();

Description

Default constructor.

It sets:

1. iHead to Null.

2. iLast to point to the head of queue.

3. iOffset to zero.

See also:

• TSglQueBase::iHead
• TSglQueBase::iLast
• TSglQueBase::iOffsetThe offset of a component link object within elements that form the list.

protected: IMPORT_C TSglQueBase(TInt aOffset);

Description

Parameters

IMPORT_C TBool IsEmpty() const;

Description

Tests whether the singly linked list is empty, i.e. has no list elements.

Return value

IMPORT_C void SetOffset(TInt aOffset);

Description

Sets the offset of the link object from the start of a singly linked list element.

Parameters

Panic codes

See also:

• TSglQueA templated class that provides the behaviour for managing a singly linked list.

IMPORT_C void Reset();

Description

Empties the singly linked list.

After a call to this function, there are no elements queued from the header; the elements are orphaned. Special care must be taken when list elements are CBase derived objects, i.e. are allocated on the heap.

protected: IMPORT_C void DoAddFirst(TAny *aPtr);

Description

Implements the insertion of a list element at the front of the singly linked list.

This function is called by TSglQue::AddFirst(T &).

Parameters

See also:

• TSglQue::AddFirst(T &)Inserts the specified list element at the front of the singly linked list.

protected: IMPORT_C void DoAddLast(TAny *aPtr);

Description

Parameters

protected: IMPORT_C void DoRemove(TAny *aPtr);

Description

Parameters

protected: TSglQueLink * iHead;

Description

protected: TSglQueLink * iLast;

Description

protected: TInt iOffset;

Description

The offset of a component link object within elements that form the list.

protected: TInt iElements;

Description

protected: TSglQueLink * iHead;

Description

A pointer to the first element in the list.

protected: TSglQueLink * iLast;

Description

A pointer to the last element in the list.