A class that provides the behaviour for managing a doubly linked list in which elements are added in order of the time until their tick count. More...
#include <e32std.h>
Public Member Functions | |
| TTickCountQue () | |
| Constructs an empty list header. | |
| void | Add (TTickCountQueLink &aRef) |
| Adds the specified list element. | |
| TTickCountQueLink * | First () const |
| Gets a pointer to the first list element in the doubly linked list. | |
| TTickCountQueLink * | RemoveFirst () |
| Removes the first list element from the linked list, if any. | |
| TTickCountQueLink * | RemoveFirst (TUint aTickCount) |
| Removes the first list element from the linked list if its tick count is prior to the current tick count. | |
 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. | |
Additional Inherited Members | |
| 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 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 class that provides the behaviour for managing a doubly linked list in which elements are added in order of the time until their tick count.
A common use for a list of this type is as a queue of timed events, where the tick counts are the expiry times of the events.
The tick count is defined by the value of the TTickCountQueLink::iTickCount member of the link element.
- API status
- Internal component API. Released API.
Constructor & Destructor Documentation
◆ TTickCountQue()
| TTickCountQue::TTickCountQue | ( | ) |
Constructs an empty list header.
(generated from Symbian Developer Library)
Member Function Documentation
◆ Add()
| void TTickCountQue::Add | ( | TTickCountQueLink & | aRef | ) |
Adds the specified list element.
The element is added into the list in order of its tick count.
- Parameters
-
aRef The list element to be inserted.
(generated from Symbian Developer Library)
◆ First()
| TTickCountQueLink * TTickCountQue::First | ( | ) | const |
Gets a pointer to the first list element in the doubly linked list.
(generated from Symbian Developer Library)
◆ RemoveFirst() [1/2]
| TTickCountQueLink * TTickCountQue::RemoveFirst | ( | ) |
Removes the first list element from the linked list, if any.
(generated from Symbian Developer Library)
◆ RemoveFirst() [2/2]
| TTickCountQueLink * TTickCountQue::RemoveFirst | ( | TUint | aTickCount | ) |
Removes the first list element from the linked list if its tick count is prior to the current tick count.
- Parameters
-
aTickCount The current tick count.
(generated from Symbian Developer Library)
The documentation for this class was generated from the following files:
