Objective Systems, Inc.  
Home
About ASN.1
Products
Free Software
Documents
Services
Resources
Resellers
Customers
Careers
About Us
Contact Us
 

Google


Objective Systems, Inc.

OSRTDListClass Class Reference

This class represents a doubly-linked list structure. More...

#include <rtxCppDList.h>

Inheritance diagram for OSRTDListClass:

OSRTDListBaseClass OSBaseType List of all members.

Public Member Functions

void append (const void *pdata)
 The append method adds an item to the end of the list.

void append (void *pdata, OSBOOL ownMemory=FALSE)
 The append method adds an item to the end of the list.

OSRTDListNodeClassgetHead ()
 This method returns a pointer to a head node of the list.

const void * getItem (int idx)
 The getItem method retrieves the data item from the list at the given index.

OSRTDListNodeClassgetTail ()
 This method returns a pointer to a tail node of the list.

void insert (int index, const void *pdata)
 The insert method inserts a data item into the list at the given indexed location.

void insert (int index, void *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.

It extends the C++ OSRTDListBaseClass type.

Definition at line 177 of file rtxCppDList.h.


Member Function Documentation

void OSRTDListClass::append void *  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 OSRTDListClass::append const void *  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.

OSRTDListNodeClass* OSRTDListClass::getHead  )  [inline]
 

This method returns a pointer to a head node of the list.

Returns:
- Pointer to head node.

Definition at line 202 of file rtxCppDList.h.

const void* OSRTDListClass::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 213 of file rtxCppDList.h.

References rtxDListFindByIndex().

OSRTDListNodeClass* OSRTDListClass::getTail  )  [inline]
 

This method returns a pointer to a tail node of the list.

Returns:
- Pointer to tail node.

Definition at line 224 of file rtxCppDList.h.

void OSRTDListClass::insert int  index,
void *  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 OSRTDListClass::insert int  index,
const void *  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