|
|
 |
 |
|
OSRTObjListClass Class ReferenceThis class represents a doubly-linked list structure for OSBaseType instances.
More...
#include <rtxCppDList.h>
Inheritance diagram for OSRTObjListClass:
List of all members.
|
Public Member Functions |
| void | append (const OSBaseType *pdata) |
| | The append method adds an item to the end of the list.
|
| void | append (OSBaseType *pdata, OSBOOL ownMemory=FALSE) |
| | The append method adds an item to the end of the list.
|
| OSRTObjListNodeClass * | getHead () |
| | This method returns a pointer to a head node of the list.
|
| const OSBaseType * | getItem (int idx) |
| | The getItem method retrieves the data item from the list at the given index.
|
| OSRTDListNodeClass * | getTail () |
| | This method returns a pointer to a tail node of the list.
|
| void | insert (int index, const OSBaseType *pdata) |
| | The insert method inserts a data item into the list at the given indexed location.
|
| void | insert (int index, OSBaseType *pdata, OSBOOL ownMemory=FALSE) |
| | The insert method inserts a data item into the list at the given indexed location.
|
Detailed Description
This class represents a doubly-linked list structure for OSBaseType instances.
It extends the C++ OSRTDListBaseClass type.
Definition at line 255 of file rtxCppDList.h.
Member Function Documentation
| void OSRTObjListClass::append |
( |
OSBaseType * |
pdata, |
|
|
OSBOOL |
ownMemory = FALSE |
|
) |
|
|
|
|
The append method adds an item to the end of the list.
- Parameters:
-
| pdata | - Pointer to data item to be appended to list. Note the pointer itself is appended - a copy is not made. |
| ownMemory | - Transfer ownership of memory to the list object. |
|
| void OSRTObjListClass::append |
( |
const OSBaseType * |
pdata |
) |
|
|
|
|
The append method adds an item to the end of the list.
- Parameters:
-
| pdata | - Pointer to data item to be appended to list. Note the pointer itself is appended - a copy is not made. |
|
|
|
This method returns a pointer to a head node of the list.
- Returns:
- - Pointer to head node.
Definition at line 280 of file rtxCppDList.h. |
| const OSBaseType* OSRTObjListClass::getItem |
( |
int |
idx |
) |
[inline] |
|
|
|
The getItem method retrieves the data item from the list at the given index.
The index is zero-based.
- Parameters:
-
| idx | - Zero-based index of the node to retrieve. |
- Returns:
- - Pointer to node structure containing the indexed data item.
Definition at line 291 of file rtxCppDList.h.
References rtxDListFindByIndex(). |
|
|
This method returns a pointer to a tail node of the list.
- Returns:
- - Pointer to tail node.
Definition at line 302 of file rtxCppDList.h. |
| void OSRTObjListClass::insert |
( |
int |
index, |
|
|
OSBaseType * |
pdata, |
|
|
OSBOOL |
ownMemory = FALSE |
|
) |
|
|
|
|
The insert method inserts a data item into the list at the given indexed location.
The index is zero-based.
- Parameters:
-
| index | - Zero-based index of insertion point. |
| pdata | - Pointer to data item to be inserted into list. Note the pointer itself is inserted - a copy is not made. |
| ownMemory | - Transfer ownership of memory to the list object. |
|
| void OSRTObjListClass::insert |
( |
int |
index, |
|
|
const OSBaseType * |
pdata |
|
) |
|
|
|
|
The insert method inserts a data item into the list at the given indexed location.
The index is zero-based.
- Parameters:
-
| index | - Zero-based index of insertion point. |
| pdata | - Pointer to data item to be inserted into list. Note the pointer itself is inserted - a copy is not made. |
|
The documentation for this class was generated from the following file:
|
This file was last modified on
1 Jun 2004. XBinder, Version 1.0.0 |