TSglQue Class Reference

#include <e32std.h>

Link against: libm.lib

class TSglQue : public TSglQueBase

Inherits from

TSglQue
- TSglQueBase

Public Member Functions
	TSglQue()
	TSglQue(TInt)
void	AddFirst(T &)
void	AddLast(T &)
T *	First()
TBool	IsFirst(const T *)
TBool	IsLast(const T *)
T *	Last()
void	Remove(T &)

Inherited Attributes
	TSglQueBase::iHead
	TSglQueBase::iLast
	TSglQueBase::iOffset

Inherited Functions
	TSglQueBase::DoAddFirst(TAny *)
	TSglQueBase::DoAddLast(TAny *)
	TSglQueBase::DoRemove(TAny *)
	TSglQueBase::IsEmpty()const
	TSglQueBase::Reset()
	TSglQueBase::SetOffset(TInt)
	TSglQueBase::TSglQueBase()
	TSglQueBase::TSglQueBase(TInt)

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.

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.

TSglQue ( TInt )

TSglQue

(

TInt

aOffset

)

[inline, explicit]

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

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

Parameter	Description
aOffset	The offset of the link object from the start of a list element. The macro _FOFF can be used to calculate this value.

Member Function Documentation

AddFirst ( T & )

void

AddFirst

(

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.

Parameter	Description
aRef	The list element to be inserted at the front of the singly linked list.

AddLast ( T & )

void

AddLast

(

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.

Parameter	Description
aRef	The 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.

Returns: 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.

Parameter	Description
aPtr	A pointer to the element whose position in the list is to be checked.

Returns: 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.

Parameter	Description
aPtr	A pointer to the element whose position in the list is to be checked.

Returns: 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.

Returns: 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 & )

void

Remove

(

T &

aRef

)

[inline]

Removes the specified element from the singly linked list.

The singly linked list must not be empty.

panic: USER 76, if the element to be removed is not in the list

Parameter	Description
aRef	A list element to be removed from the singly linked list.