mtsQueueGeneric Class Reference

#include <mtsQueue.h>

Public Types
typedef mtsGenericObject	value_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef value_type &	reference
typedef const value_type &	const_reference
typedef size_t	size_type
typedef size_t	index_type

Public Member Functions
	mtsQueueGeneric (void)
	mtsQueueGeneric (size_type size, const_reference value)
	~mtsQueueGeneric ()
void	SetSize (size_type size, const_reference value)
size_type	GetSize (void) const
size_type	GetAvailable (void) const
bool	IsFull (void) const
bool	IsEmpty (void) const
const_pointer	Put (const_reference newObject)
pointer	Peek (void) const
pointer	Get (void)

Protected Member Functions
void	Allocate (size_type size, const_reference value)
void	Free (void)

Protected Attributes
const cmnClassServicesBase *	ClassServices
pointer *	Data
pointer *	Head
pointer *	Tail
pointer *	Sentinel
size_type	Size

Member Typedef Documentation

const_pointer

typedef const value_type* mtsQueueGeneric::const_pointer

const_reference

typedef const value_type& mtsQueueGeneric::const_reference

index_type

typedef size_t mtsQueueGeneric::index_type

pointer

typedef value_type* mtsQueueGeneric::pointer

reference

typedef value_type& mtsQueueGeneric::reference

size_type

typedef size_t mtsQueueGeneric::size_type

value_type

typedef mtsGenericObject mtsQueueGeneric::value_type

Constructor & Destructor Documentation

mtsQueueGeneric() [1/2]

mtsQueueGeneric::mtsQueueGeneric ( void )

inline

mtsQueueGeneric() [2/2]

mtsQueueGeneric::mtsQueueGeneric ( size_type size, const_reference value )

inline

~mtsQueueGeneric()

mtsQueueGeneric::~mtsQueueGeneric ( )

inline

Member Function Documentation

Allocate()

void mtsQueueGeneric::Allocate ( size_type size, const_reference value )

inlineprotected

Free()

void mtsQueueGeneric::Free ( void )

inlineprotected

Get()

pointer mtsQueueGeneric::Get ( void )

inline

Pop the next object to be read from the queue.

Returns

Pointer to element just popped (use iterator instead?)

GetAvailable()

size_type mtsQueueGeneric::GetAvailable ( void ) const

inline

Returns number of elements available in queue, i.e. the number of slots used.

GetSize()

size_type mtsQueueGeneric::GetSize ( void ) const

inline

Returns size of queue.

IsEmpty()

bool mtsQueueGeneric::IsEmpty ( void ) const

inline

Returns true if queue is empty.

IsFull()

bool mtsQueueGeneric::IsFull ( void ) const

inline

Returns true if queue is full.

Peek()

pointer mtsQueueGeneric::Peek ( void ) const

inline

Get a pointer to the next object to be read, but do not remove the item from the queue.

Returns

Pointer to top element in queue (use iterator instead?)

Put()

const_pointer mtsQueueGeneric::Put ( const_reference newObject )

inline

Copy an object to the queue.

Parameters

in	reference to the object to be copied

Returns

Pointer to element in queue (use iterator instead?)

SetSize()

void mtsQueueGeneric::SetSize ( size_type size, const_reference value )

inline

Sets the size of the queue (destructive, i.e. won't preserve previously queued elements).

Member Data Documentation

ClassServices

const cmnClassServicesBase* mtsQueueGeneric::ClassServices

protected

Data

pointer* mtsQueueGeneric::Data

protected

Head

pointer* mtsQueueGeneric::Head

protected

Sentinel

pointer* mtsQueueGeneric::Sentinel

protected

Size

size_type mtsQueueGeneric::Size

protected

Tail

pointer* mtsQueueGeneric::Tail

protected

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsQueue.h