Rogue Wave banner
Previous fileTop of DocumentContentsIndex pageNext file
Essential Tools Module Reference Guide

RWGQueue(type)

Module:  Essential Tools Module   Group:  Generic


Does not inherit

Local Index

Members

Synopsis

#include <rw/gqueue.h>
declare(RWGQueue, type)
RWGQueue(type) a ;

Description

Class RWGQueue(type) represents a group of ordered elements, not accessible by an external key. A RWGQueue(type) is a first in, first out (FIFO) sequential list for which insertions are made at one end (the "tail"), but all removals are made at the other (the "head"). Hence, the ordering is determined externally by the ordering of the insertions. Duplicates are allowed. This class is implemented as a singly-linked list. Objects of type RWGQueue(type) are declared with macros defined in the standard C++ header file <generic.h>.


NOTE -- RWGQueue is deprecated. Please use RWTQueue.

In order to find a particular item within the collection, a user-provided global "tester" function is required to test for a "match", definable in any consistent way. This function should have prototype:

The argument c is a candidate within the collection to be tested for a match. The argument d is for your convenience and will be passed to yourTesterFunction(). The function should return TRUE if a "match" is found between c and d.

In order to simplify the documentation below, an imaginary typedef:

has been used for this tester function.

Persistence

None

Public Constructors

RWGQueue(type)();
RWGQueue(type)(type* a);
RWGQueue(type)(const RWGQueue(type)& q);

Assignment Operator

void
operator=(const RWGQueue(type)& q);

Public Member Functions

type*
append(type* a);
void
clear();
RWBoolean
contains(yourTester t, const void* d) const;
RWBoolean
containsReference(const type* e) const;
size_t
entries() const; 
type*
first() const;
type*
get();
RWBoolean
isEmpty() const;
type*
insert(type* a);
type*
last();
size_t
occurrencesOf(yourTester t, const void* d) const;
size_t
occurrencesOfReference(const type* e) const;


Previous fileTop of DocumentContentsIndex pageNext file

©2004 Copyright Quovadx, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.