TSglQueBase Class Reference

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

#include <e32std.h>

Inheritance diagram for TSglQueBase:

Public Member Functions
IMPORT_C TBool	IsEmpty () const
	Tests whether the singly linked list is empty, i.e.
IMPORT_C void	SetOffset (TInt aOffset)
	Sets the offset of the link object from the start of a singly linked list element.
IMPORT_C void	Reset ()
	Empties the singly linked list.

Protected Member Functions
IMPORT_C	TSglQueBase ()
	Default constructor.
IMPORT_C	TSglQueBase (TInt aOffset)
	Constructor with specified offset.
IMPORT_C void	DoAddFirst (TAny *aPtr)
	Implements the insertion of a list element at the front of the singly linked list.
IMPORT_C void	DoAddLast (TAny *aPtr)
	Implements the insertion of a list element at the back of the singly linked list.
IMPORT_C void	DoRemove (TAny *aPtr)
	Implements the removal of a list element from the singly linked list.

Protected Attributes
TSglQueLink *	iHead
	A pointer to the first element in the list.
TSglQueLink *	iLast
	A pointer to the last element in the list.
TInt	iOffset
	The offset of a component link object within elements that form the list.

Friends
class	TSglQueIterBase

Detailed 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.

See also

TSglQue

API status

Published to all clients. Released API.

Definition at line 278 of file e32std.h.

Constructor & Destructor Documentation

TSglQueBase() [1/2]

IMPORT_C TSglQueBase::TSglQueBase ( )

protected

Default constructor.

It sets:

1. iHead to Null.
2. iLast to point to the head of queue.
3. iOffset to zero.

iHead iLast iOffset

(generated from Symbian Developer Library)

TSglQueBase() [2/2]

IMPORT_C TSglQueBase::TSglQueBase ( TInt  aOffset )

protected

Constructor with specified offset.

It sets:

1. iHead to Null
2. iLast to point to the head of queue.
3. iOffset to the specified value.

Parameters

aOffset

The offset of a link object within an element.

Panic condition: USER 75, if aOffset is not divisible by four

(generated from Symbian Developer Library)

Member Function Documentation

DoAddFirst()

IMPORT_C void TSglQueBase::DoAddFirst ( TAny *  aPtr )

protected

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

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

TSglQue::AddFirst

Parameters

aPtr	An untyped pointer to the element to be inserted.

(generated from Symbian Developer Library)

DoAddLast()

IMPORT_C void TSglQueBase::DoAddLast ( TAny *  aPtr )

protected

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

This function is called by TSglQue::AddLast().

TSglQue::AddLast

Parameters

aPtr	An untyped pointer to the element to be inserted.

(generated from Symbian Developer Library)

DoRemove()

IMPORT_C void TSglQueBase::DoRemove ( TAny *  aPtr )

protected

Implements the removal of a list element from the singly linked list.

This function is called by TSglQue::Remove().

TSglQue::Remove

Parameters

aPtr	An untyped pointer to the element to be removed.

(generated from Symbian Developer Library)

IsEmpty()

IMPORT_C TBool TSglQueBase::IsEmpty

(

)

const

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

has no list elements.

(generated from Symbian Developer Library)

Reset()

IMPORT_C void TSglQueBase::Reset

(

)

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.

(generated from Symbian Developer Library)

SetOffset()

IMPORT_C void TSglQueBase::SetOffset

(

TInt

aOffset

)

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

Parameters

aOffset

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

Panic condition: USER 75, if aOffset is not divisible by four.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

TSglQueIterBase

friend class TSglQueIterBase

friend

Definition at line 308 of file e32std.h.

Member Data Documentation

iHead

TSglQueLink* TSglQueBase::iHead

protected

A pointer to the first element in the list.

Definition at line 294 of file e32std.h.

iLast

TSglQueLink* TSglQueBase::iLast

protected

A pointer to the last element in the list.

Definition at line 299 of file e32std.h.

iOffset

TInt TSglQueBase::iOffset

protected

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

Definition at line 304 of file e32std.h.

---

The documentation for this class was generated from the following files:

• e32std.h
• e32std.h.dox