TDeltaQueBase Class Reference

A base class that provides implementation for the TDeltaQue template class. More...

#include <e32std.h>

Inheritance diagram for TDeltaQueBase:

Public Member Functions
IMPORT_C TBool	CountDown ()
	Decrements the delta value of the first element by one, and returns true if the result is negative or zero.
IMPORT_C TBool	CountDown (TInt aValue)
	Decrements the delta value of the first element by the specified value, and returns true if the result is negative or zero.
IMPORT_C TBool	FirstDelta (TInt &aValue)
	Gets the delta value of the first list element.
IMPORT_C void	Reset ()
	Empties the doubly linked list, and resets the first delta pointer.
Public Member Functions inherited from TDblQueBase
IMPORT_C TBool	IsEmpty () const
	Tests whether the doubly linked list is empty, i.e.
IMPORT_C void	SetOffset (TInt aOffset)
	Sets the offset of the link object from the start of a doubly linked list element.
IMPORT_C void	Reset ()
	Empties the doubly linked list.

Protected Member Functions
IMPORT_C	TDeltaQueBase ()
	Default constructor.
IMPORT_C	TDeltaQueBase (TInt aOffset)
	Constructor with specified offset.
IMPORT_C void	DoAddDelta (TAny *aPtr, TInt aDelta)
	Implements the addition of the specified list element into the list.
IMPORT_C void	DoRemove (TAny *aPtr)
	Implements the removal of the specified list element from the list.
IMPORT_C TAny *	DoRemoveFirst ()
	Implements the removal of the first list element from the linked list if its delta value is zero or negative.
Protected Member Functions inherited from TDblQueBase
IMPORT_C	TDblQueBase ()
	Default constructor.
IMPORT_C	TDblQueBase (TInt aOffset)
	Constructor with specified offset.
IMPORT_C void	DoAddFirst (TAny *aPtr)
	Implements the insertion of the specified list element at the front of the doubly linked list.
IMPORT_C void	DoAddLast (TAny *aPtr)
	Implements the insertion of the specified list element at the back of the doubly linked list.
IMPORT_C void	DoAddPriority (TAny *aPtr)
	Implements the insertion of the specified list element in priority order.
IMPORT_C void	__DbgTestEmpty () const
	Tests whether the queue is empty.

Protected Attributes
TInt *	iFirstDelta
	Pointer to the delta value in the first link element.
Protected Attributes inherited from TDblQueBase
TDblQueLink	iHead
	The head, or anchor point of the queue.
TInt	iOffset
	The offset of a component link object within elements that form the list.

Detailed Description

A base class that provides implementation for the TDeltaQue template class.

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

See also

TDeltaQue

API status

Published to all clients. Released API.

Definition at line 372 of file e32std.h.

Constructor & Destructor Documentation

TDeltaQueBase() [1/2]

IMPORT_C TDeltaQueBase::TDeltaQueBase ( )

protected

Default constructor.

It sets iFirstDelta to NULL.

TDeltaQueBase::iFirstDelta

(generated from Symbian Developer Library)

TDeltaQueBase() [2/2]

IMPORT_C TDeltaQueBase::TDeltaQueBase ( TInt  aOffset )

protected

Constructor with specified offset.

It sets:

1. iFirstDelta to NULL
2. TDblQueBase::iOffset to the specified value, through a call to the base class constructor.

TDeltaQueBase::iFirstDelta TDblQueBase::iOffset

Parameters

aOffset

The offset of a link object within an element.

(generated from Symbian Developer Library)

Member Function Documentation

CountDown() [1/2]

IMPORT_C TBool TDeltaQueBase::CountDown

(

)

Decrements the delta value of the first element by one, and returns true if the result is negative or zero.

(generated from Symbian Developer Library)

CountDown() [2/2]

IMPORT_C TBool TDeltaQueBase::CountDown

(

TInt

aValue

)

Decrements the delta value of the first element by the specified value, and returns true if the result is negative or zero.

Parameters

aValue

The amount by which the delta value is to be reduced.

(generated from Symbian Developer Library)

DoAddDelta()

IMPORT_C void TDeltaQueBase::DoAddDelta ( TAny *  aPtr, TInt  aDelta  )

protected

Implements the addition of the specified list element into the list.

This function is called by TDeltaQue::Add().

TDeltaQue::Add

Parameters

aPtr	Pointer to the list element to be inserted.
aDelta	The 'distance' from the nominal zero point.

(generated from Symbian Developer Library)

DoRemove()

IMPORT_C void TDeltaQueBase::DoRemove ( TAny *  aPtr )

protected

Implements the removal of the specified list element from the list.

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

TDeltaQue::Remove

Parameters

aPtr	Pointer to the list element to be removed.

(generated from Symbian Developer Library)

DoRemoveFirst()

IMPORT_C TAny * TDeltaQueBase::DoRemoveFirst ( )

protected

Implements the removal of the first list element from the linked list if its delta value is zero or negative.

This function is called by TDeltaQue::RemoveFirst().

TDeltaQue::RemoveFirst

(generated from Symbian Developer Library)

FirstDelta()

IMPORT_C TBool TDeltaQueBase::FirstDelta

(

TInt &

aValue

)

Gets the delta value of the first list element.

Parameters

aValue

On return, contsins the delta value of the first element. Note that this remains unchanged if there is no first element.

(generated from Symbian Developer Library)

Reset()

IMPORT_C void TDeltaQueBase::Reset

(

)

Empties the doubly linked list, and resets the first delta pointer.

(generated from Symbian Developer Library)

Member Data Documentation

iFirstDelta

TInt* TDeltaQueBase::iFirstDelta

protected

Pointer to the delta value in the first link element.

Definition at line 389 of file e32std.h.

---

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

• e32std.h
• e32std.h.dox