OSRTDListBaseClass Class Reference

This class is a base class for C++ representations of a doubly-linked list classes. More...

#include <rtxCppDList.h>

Inheritance diagram for OSRTDListBaseClass:

OSRTBaseType OSRTDListClass OSRTObjListClass

List of all members.


Public Member Functions

 OSRTDListBaseClass ()
 The default constructor initializes the list contents to empty.
virtual ~OSRTDListBaseClass ()
 The destructor will delete all the nodes in the list.
OSUINT32 getCount () const
 This method returns count of items in the list.
OSRTDList * getList ()
 This method returns a pointer to OSRTDList structure for the list instance.
const OSRTDList * getList () const
 This method returns a const pointer to OSRTDList structure for the list instance.
void remove (int index)
 The remove method removes the data item at the given index from the list.

Detailed Description

This class is a base class for C++ representations of a doubly-linked list classes.

It is derived from the OSRTBaseType class as well as the C OSRTDList structure. This class provides a basic functionality for C++ doubly-linked list.

Definition at line 180 of file rtxCppDList.h.


Member Function Documentation

OSUINT32 OSRTDListBaseClass::getCount (  )  const [inline]

This method returns count of items in the list.

Returns:
- Count of items in the list

Definition at line 203 of file rtxCppDList.h.

OSRTDList* OSRTDListBaseClass::getList (  )  [inline]

This method returns a pointer to OSRTDList structure for the list instance.

Returns:
- a pointer to OSRTDList structure for the list instance.

Definition at line 212 of file rtxCppDList.h.

const OSRTDList* OSRTDListBaseClass::getList (  )  const [inline]

This method returns a const pointer to OSRTDList structure for the list instance.

Returns:
- a const pointer to OSRTDList structure for the list instance.

Definition at line 221 of file rtxCppDList.h.

void OSRTDListBaseClass::remove ( int  index  ) 

The remove method removes the data item at the given index from the list.

The index is zero-based.

Parameters:
index - Zero-based index of item to be removed.


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