head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.36; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.50; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.53.59; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.54; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# SGQueue< T > Class Template Reference

SGQueue defines an interface for a FIFO. More...

`#include <SGQueue.hxx>`

Inheritance diagram for SGQueue< T >:

List of all members.

## Public Methods
| SGQueue ()
| Create a new SGQueue object.
virtual | ~SGQueue ()
| Destroy this object.
virtual bool | empty ()=0
| Returns whether this queue is empty (contains no elements).
virtual void | push (const T &item)=0
| Add an item to the end of the queue.
virtual T | pop ()=0
| Get an item from the head of the queue.
## Protected Attributes
std::queue< T > | fifo

## Detailed Description

### template<class T>
class SGQueue< T >

SGQueue defines an interface for a FIFO.

It can be implemented using different types of synchronization and protection.

Definition at line 22 of file SGQueue.hxx.

## Member Function Documentation

template<class T>
virtual bool SGQueue< T >::empty | ( |  | ) | `[pure virtual]`

| Returns whether this queue is empty (contains no elements). Returns: bool True if queue is empty, otherwisr false. Implemented in SGLockedQueue< T, SGLOCK >, and SGBlockingQueue< T >.

template<class T>
virtual T SGQueue< T >::pop | ( |  | ) | `[pure virtual]`

| Get an item from the head of the queue. Returns: T next available object. Implemented in SGLockedQueue< T, SGLOCK >, and SGBlockingQueue< T >.

template<class T>
virtual void SGQueue< T >::push | ( | const T & | item | ) | `[pure virtual]`

  | Add an item to the end of the queue. Parameters:
  T | object to add.
Implemented in SGLockedQueue< T, SGLOCK >, and SGBlockingQueue< T >.

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

- SGQueue.hxx

@ 1.3 log @Oops, try again. @ text @d170 1 a170 1