OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | List of all members
openjaus::system::Queue< Type > Class Template Reference

This is a brief description. More...

#include <Queue.h>

Inherits openjaus::system::Condition.

Public Member Functions

 Queue ()
 
virtual ~Queue ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
const std::list< Type > & getObjects () const
 Accessor to get the value of objects. More...
 
const MutexgetMutex () const
 Accessor to get the value of mutex. More...
 
virtual bool push (Type item)
 
Type pop ()
 Operation pop. More...
 
bool isEmpty () const
 
int getSize () const
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::system::Condition
 Condition ()
 
virtual ~Condition ()
 
void signal ()
 Operation signal. More...
 
void signalAll ()
 Operation signalAll. More...
 
bool timedWait (int milliseconds)
 Operation timedWait. More...
 

Protected Attributes

std::string name
 
std::list< Type > objects
 
Mutex mutex
 
- Protected Attributes inherited from openjaus::system::Condition
int numberOfWaitingThreads
 
pthread_cond_t condition
 
pthread_mutex_t mutex
 

Additional Inherited Members

- Static Public Attributes inherited from openjaus::system::Condition
static const int DEFAULT_WAIT_MSEC = 500
 

Detailed Description

template<class Type>
class openjaus::system::Queue< Type >

Detailed description.

Author
Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

§ Queue()

template<class Type >
openjaus::system::Queue< Type >::Queue ( )

§ ~Queue()

template<class Type >
openjaus::system::Queue< Type >::~Queue ( )
virtual

Member Function Documentation

§ getMutex()

template<class Type >
const Mutex & openjaus::system::Queue< Type >::getMutex ( ) const

§ getName()

template<class Type >
std::string openjaus::system::Queue< Type >::getName ( void  ) const

§ getObjects()

template<class Type >
const std::list< Type > & openjaus::system::Queue< Type >::getObjects ( ) const

§ getSize()

template<class Type >
int openjaus::system::Queue< Type >::getSize ( ) const

§ isEmpty()

template<class Type >
bool openjaus::system::Queue< Type >::isEmpty ( ) const

§ pop()

template<class Type >
Type openjaus::system::Queue< Type >::pop ( )

§ push()

template<class Type>
bool openjaus::system::Queue< Type >::push ( Type  item)
virtual
Parameters
item

Reimplemented in openjaus::system::PriorityQueue.

§ setName()

template<class Type >
bool openjaus::system::Queue< Type >::setName ( std::string  name)
Parameters
nameThe value of the new name.

§ toString()

template<class Type >
std::string openjaus::system::Queue< Type >::toString ( ) const
virtual

Reimplemented from openjaus::system::Condition.

Reimplemented in openjaus::system::PriorityQueue.

Member Data Documentation

§ mutex

template<class Type>
Mutex openjaus::system::Queue< Type >::mutex
protected

§ name

template<class Type>
std::string openjaus::system::Queue< Type >::name
protected

§ objects

template<class Type>
std::list< Type > openjaus::system::Queue< Type >::objects
protected

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