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

Google


Objective Systems, Inc.

OSRTObjListClass Class Reference

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

#include <rtxCppDList.h>

Inheritance diagram for OSRTObjListClass:

OSRTDListBaseClass OSBaseType List of all members.

Public Member Functions

 OSRTObjListClass ()
 The default constructor initializes the list contents to empty.
void append (OSBaseType *pdata, OSBOOL ownMemory=FALSE)
 The append method adds an item to the end of the list.
OSRTObjListNodeClassgetHead ()
 This method returns a pointer to a head node of the list.
const OSRTObjListNodeClassgetHead () const
 This method returns a pointer to a head node of the list.
const OSBaseTypegetItem (int idx) const
 The getItem method retrieves the data item from the list at the given index.
OSRTObjListNodeClassgetTail ()
 This method returns a pointer to a tail node of the list.
const OSRTObjListNodeClassgetTail () const
 This method returns a pointer to a tail node of the list.
void insert (int index, OSBaseType *pdata, OSBOOL ownMemory=FALSE)
 The insert method inserts a data item into the list at the given indexed location.

Protected Member Functions

 OSRTObjListClass (const OSRTObjListClass &o)

Detailed Description

This class represents a doubly-linked list structure for objects.

It extends the C++ OSRTDListBaseClass type. It is similar to the OSRTDListClass described above except that the base type for items in the list is OSBaseType. This allows items in the list to be properly destructed when memory ownership for the items is transferred to the list object.

Definition at line 340 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.

const OSRTObjListNodeClass* OSRTObjListClass::getHead  )  const [inline]
 

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

Returns:
- Pointer to head node.

Definition at line 374 of file rtxCppDList.h.

OSRTObjListNodeClass* OSRTObjListClass::getHead  )  [inline]
 

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

Returns:
- Pointer to head node.

Definition at line 365 of file rtxCppDList.h.

const OSBaseType* OSRTObjListClass::getItem int  idx  )  const [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 385 of file rtxCppDList.h.

References OSRTObjListNodeClass::getData().

const OSRTObjListNodeClass* OSRTObjListClass::getTail  )  const [inline]
 

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

Returns:
- Pointer to tail node.

Definition at line 405 of file rtxCppDList.h.

OSRTObjListNodeClass* OSRTObjListClass::getTail  )  [inline]
 

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

Returns:
- Pointer to tail node.

Definition at line 396 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.


The documentation for this class was generated from the following file:

This file was last modified on 8 Jan 2007.
XBinder, Version 1.1.9