TSglQue Class Reference

#include <e32std.h>

class TSglQue : public TSglQueBase

Inherits from

Detailed Description

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

It also acts as the head of the list, maintaining the pointers into the list.

The template parameter defines the type of element that forms the singly linked list and is the class that acts as host to the link object.

See also: TSglQueLink

Constructor & Destructor Documentation

TSglQue ( )

TSglQue()[inline]

Constructs an empty list header and sets the offset value of the link object to zero.

In practice, never assume that the offset of the link object from the start of a list element is zero, even if the link object is declared as the first data member in the list element class.

If this default constructor is used, then call the SetOffset() function of the base class to ensure that the offset value is set correctly.

See also: TSglQueBase::SetOffset

TSglQue ( TInt )

TSglQue(TIntaOffset)[inline, explicit]

Constructs an empty list header and sets the offset of the link object to the specified value.

See also: _FOFF

Parameters
aOffsetThe offset of the link object from the start of a list element. The macro _FOFF can be used to calculate this value.
Panic Codes
USER75, if aOffset is not divisible by four.

Member Function Documentation

AddFirst ( T & )

voidAddFirst(T &aRef)[inline]

Inserts the specified list element at the front of the singly linked list.

If the list is not empty, the specified element becomes the first in the list. What was previously the first element becomes the second in the list.

Parameters
aRefThe list element to be inserted at the front of the singly linked list.

AddLast ( T & )

voidAddLast(T &aRef)[inline]

Inserts the specified list element at the back of the singly linked list.

If the list is not empty, the specified element becomes the last in the list. What was previously the last element becomes the next to last element in the list.

Parameters
aRefThe list element to be inserted at the back of the singly linked list.

First ( )

T *First()const [inline]

Gets a pointer to the first list element in the singly linked list.

Return Value
A pointer to the first list element in the singly linked list. If the list is empty, this pointer is not necessarily NULL and must not be assumed to point to a valid object.

IsFirst ( const T * )

TBool IsFirst(const T *aPtr)const [inline]

Tests whether the specified element is the first in the singly linked list.

Parameters
aPtrA pointer to the element whose position in the list is to be checked.
Return Value
True, if the element is the first in the list; false, otherwise.

IsLast ( const T * )

TBool IsLast(const T *aPtr)const [inline]

Tests whether the specified element is the last in the singly linked list.

Parameters
aPtrA pointer to the element whose position in the list is to be checked.
Return Value
True, if the element is the last in the list; false, otherwise.

Last ( )

T *Last()const [inline]

Gets a pointer to the last list element in the singly linked list.

Return Value
A pointer to the last list element in the singly linked list. If the list is empty, this pointer is not necessarily NULL and must not be assumed to point to a valid object.

Remove ( T & )

voidRemove(T &aRef)[inline]

Removes the specified element from the singly linked list.

The singly linked list must not be empty.

Parameters
aRefA list element to be removed from the singly linked list.
Panic Codes
USER76, if the element to be removed is not in the list