TDeltaQueBase Class Reference

#include <e32std.h>

class TDeltaQueBase : public TDblQueBase

Inherits from

Protected Attributes
TInt *iFirstDelta
Public Member Functions
IMPORT_C TBoolCountDown()
IMPORT_C TBoolCountDown(TInt)
IMPORT_C TBoolFirstDelta(TInt &)
IMPORT_C voidReset()
Protected Member Functions
TDeltaQueBase()
TDeltaQueBase(TInt)
IMPORT_C voidDoAddDelta(TAny *, TInt)
IMPORT_C voidDoRemove(TAny *)
IMPORT_C TAny *DoRemoveFirst()
Inherited Attributes
TDblQueBase::iHead
TDblQueBase::iOffset
Inherited Functions
TDblQueBase::DoAddFirst(TAny *)
TDblQueBase::DoAddLast(TAny *)
TDblQueBase::DoAddPriority(TAny *)
TDblQueBase::IsEmpty()const
TDblQueBase::SetOffset(TInt)
TDblQueBase::TDblQueBase()
TDblQueBase::TDblQueBase(TInt)
TDblQueBase::__DbgTestEmpty()const

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

Member Attribute Documentation

iFirstDelta

TInt *iFirstDelta[protected]

Pointer to the delta value in the first link element.

Constructor & Destructor Documentation

TDeltaQueBase ( )

IMPORT_CTDeltaQueBase()[protected]

Default constructor.

It sets iFirstDelta to NULL.

See also: TDeltaQueBase::iFirstDelta

TDeltaQueBase ( TInt )

IMPORT_CTDeltaQueBase(TIntaOffset)[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.

See also: TDeltaQueBase::iFirstDelta TDblQueBase::iOffset

Parameters
aOffsetThe offset of a link object within an element.

Member Function Documentation

CountDown ( )

IMPORT_C TBoolCountDown()

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

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

CountDown ( TInt )

IMPORT_C TBoolCountDown(TIntaValue)

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

Parameters
aValueThe amount by which the delta value is to be reduced.
Return Value
True, if the resulting delta value is negative or zero; false, if the value is positive, or there is no first element.

DoAddDelta ( TAny *, TInt )

IMPORT_C voidDoAddDelta(TAny *aPtr,
TIntaDelta
)[protected]

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

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

See also: TDeltaQue::Add

Parameters
aPtrPointer to the list element to be inserted.
aDeltaThe 'distance' from the nominal zero point.

DoRemove ( TAny * )

IMPORT_C voidDoRemove(TAny *aPtr)[protected]

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

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

See also: TDeltaQue::Remove

Parameters
aPtrPointer to the list element to be removed.

DoRemoveFirst ( )

IMPORT_C TAny *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().

See also: TDeltaQue::RemoveFirst

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

FirstDelta ( TInt & )

IMPORT_C TBoolFirstDelta(TInt &aValue)

Gets the delta value of the first list element.

Parameters
aValueOn return, contsins the delta value of the first element. Note that this remains unchanged if there is no first element.
Return Value
True, if there is a first element; false, otherwise.

Reset ( )

IMPORT_C voidReset()

Reimplemented from TDblQueBase::Reset()

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

© Nokia 2005.