Class TDeltaQueBase

class TDeltaQueBase : public TDblQueBase;

Description

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

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

Derivation

• TDblQueBase - A base class that provides implementation for the doubly linked list header.

• TDeltaQueBase - A base class that provides implementation for the TDeltaQue template class.

Members

Defined in TDeltaQueBase:

• CountDown()Decrements the delta value of the first element by one, and returns true if the ...
• CountDown(TInt)Decrements the delta value of the first element by the specified value, and retu...
• DoAddDelta(TAny *,TInt)Implements the addition of the specified list element into the list.
• DoRemove(TAny *)Implements the removal of the specified list element from the list.
• DoRemoveFirst()Implements the removal of the first list element from the linked list if its del...
• FirstDelta(TInt &)Gets the delta value of the first list element.
• Reset()Empties the doubly linked list, and resets the first delta pointer.
• TDeltaQueBase()Default constructor.
• TDeltaQueBase(TInt)Constructor with specified offset.
• iFirstDeltaPointer to the delta value in the first link element.

Inherited from TDblQueBase:

• DoAddFirst(TAny *)Implements the insertion of the specified list element at the front of the doubl...
• DoAddLast(TAny *)Implements the insertion of the specified list element at the back of the doubly...
• DoAddPriority(TAny *)Implements the insertion of the specified list element in priority order.
• IsEmpty()constTests whether the doubly linked list is empty, i.e. has no list elements.
• SetOffset(TInt)Sets the offset of the link object from the start of a doubly linked list elemen...
• TDblQueBase(TInt)Constructor with specified offset.
• __DbgTestEmpty()constTests whether the queue is empty.
• iHeadThe head, or anchor point of the queue.
• iOffsetThe offset of a component link object within elements that form the list.

See also:

• TDeltaQueA templated class that provides the behaviour for managing a doubly linked list ...

protected: IMPORT_C TDeltaQueBase();

Description

Default constructor.

It sets iFirstDelta to NULL.

See also:

• TDeltaQueBase::iFirstDeltaPointer to the delta value in the first link element.

protected: IMPORT_C TDeltaQueBase(TInt aOffset);

Description

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.

Parameters

TInt aOffset The offset of a link object within an element.

See also:

• TDeltaQueBase::iFirstDeltaPointer to the delta value in the first link element.
• TDblQueBase::iOffsetThe offset of a component link object within elements that form the list.

IMPORT_C TBool CountDown();

Description

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

Return value

TBool True, if the resulting delta value is negative or zero; false, if the value is positive, or there is no first element.

IMPORT_C TBool CountDown(TInt aValue);

Description

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

Parameters

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

Return value

TBool True, if the resulting delta value is negative or zero; false, if the value is positive, or there is no first element.

IMPORT_C TBool FirstDelta(TInt &aValue);

Description

Gets the delta value of the first list element.

Parameters

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

Return value

TBool True, if there is a first element; false, otherwise.

IMPORT_C void Reset();

Description

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

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

Description

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

This function is called by TDeltaQue::Add(T &,TInt).

Parameters

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

See also:

• TDeltaQue::Add(T &,TInt)Adds the specified list element, having the specified 'distance' from the nomina...

protected: IMPORT_C void DoRemove(TAny *aPtr);

Description

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

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

Parameters

TAny *aPtr Pointer to the list element to be removed.

See also:

• TDeltaQue::Remove(T &)Removes the specified list element from the linked list.

protected: IMPORT_C TAny* DoRemoveFirst();

Description

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().

Return value

TAny * A pointer to the element removed from the linked list. This is NULL, if the first element has a positive delta value.

See also:

• TDeltaQue::RemoveFirst()Removes the first list element from the linked list if its delta value is zero o...

protected: TInt * iFirstDelta;

Description

Pointer to the delta value in the first link element.