Class TDeltaQue

class TDeltaQue : public TDeltaQueBase;

Description

A templated class that provides the behaviour for managing a doubly linked list in which elements represent values which are increments, or deltas, on the value represented by a preceding element.

The list is ordered so that the head of the queue represents a nominal zero point.

The delta value of a new element represents its 'distance' from the nominal zero point. The new element is added into the list, and the delta values of adjacent elements (and of the new element, if necessary) are adjusted, so that the sum of all deltas, up to and including the new element, is the same as the new element's intended 'distance' from the nominal zero point.

A common use for a list of this type is as a queue of timed events, where the delta values represent the intervals between the events.

The delta value is defined by the value of the TDeltaQueLink::iDelta member of the link element.

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

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.

• TDeltaQue - A templated class that provides the behaviour for managing a doubly linked list ...

Members

Defined in TDeltaQue:

• Add(T &,TInt)Adds the specified list element, having the specified 'distance' from the nomina...
• Remove(T &)Removes the specified list element from the linked list.
• RemoveFirst()Removes the first list element from the linked list if its delta value is zero o...
• TDeltaQue()Constructs an empty list header and sets the offset value of the link object to ...
• TDeltaQue(TInt)Constructs an empty list header and sets the offset of the link object to the sp...

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.

Inherited from 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(TInt)Constructor with specified offset.
• iFirstDeltaPointer to the delta value in the first link element.

See also:

• TDeltaQueLink...
• TDeltaQueLink::iDeltaThe delta value.

inline TDeltaQue();

Description

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 TDblQueBase::SetOffset(TInt) function in the base class to ensure that the offset value is set correctly.

TDeltaQueBase::iFirstDelta is set to NULL.

See also:

• TDblQueBase::SetOffset(TInt)Sets the offset of the link object from the start of a doubly linked list elemen...

inline TDeltaQue(TInt aOffset);

Description

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

TDeltaQueBase::iFirstDelta is set to NULL.

Parameters

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

Panic codes

USER 78, if aOffset is not divisible by four.

inline void Add(T &aRef, TInt aDelta);

Description

Adds the specified list element, having the specified 'distance' from the nominal zero point, into the list.

The element is added into the list, the adjacent delta values adjusted, and a suitable delta value assigned to the new element, so that the new element is at the specified 'distance' from the nominal zero point.

Parameters

T &aRef The list element to be inserted. TInt aDelta The 'distance' from the nominal zero point.

inline void Remove(T &aRef);

Description

Removes the specified list element from the linked list.

The delta value of the element following the removed element is adjusted so that its 'distance' from the nominal zero point remains the same.

Parameters

T &aRef The list element to be removed.

inline T* RemoveFirst();

Description

Removes the first list element from the linked list if its delta value is zero or negative.

Return value

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