ERC CISST - cisst software

---

mtsQueue< _elementType > Class Template Reference
[Multi Task Support]

#include <mtsQueue.h>

Inheritance diagram for mtsQueue< _elementType >:

[legend]Collaboration diagram for mtsQueue< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class mtsQueue< _elementType >

Defines a queue that can be accessed in a thread-safe manner, assuming that there is only one reader and one writer and that pointer updates are atomic.

Definition at line 41 of file mtsQueue.h.

Public Types

• typedef _elementType 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

• mtsQueue (void)
• mtsQueue (size_type size, const_reference value)
• ~mtsQueue ()
• 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 typename mtsGenericTypesUnwrap< value_type >::BaseType &newObject)
• pointer Peek (void) const
• pointer Get (void)

Protected Member Functions

• void Allocate (size_type size, const_reference value)

Protected Attributes

• pointer Data
• pointer Head
• pointer Tail
• pointer Sentinel
• size_type Size

---

Member Function Documentation

template<class _elementType>

void mtsQueue< _elementType >::SetSize	(	size_type	size,
		const_reference	value
	)			[inline]

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

Definition at line 101 of file mtsQueue.h.

Referenced by mtsCommandQueuedWrite< _argumentType >::Allocate(), and mtsCommandQueuedWrite< _argumentType >::mtsCommandQueuedWrite().

template<class _elementType>

size_type mtsQueue< _elementType >::GetSize

(

void

)

const [inline]

Returns size of queue.

Definition at line 108 of file mtsQueue.h.

template<class _elementType>

size_type mtsQueue< _elementType >::GetAvailable

(

void

)

const [inline]

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

Definition at line 115 of file mtsQueue.h.

template<class _elementType>

bool mtsQueue< _elementType >::IsFull

(

void

)

const [inline]

Returns true if queue is full.

Definition at line 126 of file mtsQueue.h.

template<class _elementType>

bool mtsQueue< _elementType >::IsEmpty

(

void

)

const [inline]

Returns true if queue is empty.

Definition at line 136 of file mtsQueue.h.

template<class _elementType>

const_pointer mtsQueue< _elementType >::Put

(

const typename mtsGenericTypesUnwrap< value_type >::BaseType &

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?)

Definition at line 148 of file mtsQueue.h.

Referenced by mtsCommandQueuedWrite< _argumentType >::Execute().

template<class _elementType>

pointer mtsQueue< _elementType >::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?)

Definition at line 170 of file mtsQueue.h.

template<class _elementType>

pointer mtsQueue< _elementType >::Get

(

void

)

[inline]

Pop the next object to be read from the queue.

Returns:

Pointer to element just popped (use iterator instead?)

Definition at line 181 of file mtsQueue.h.

Referenced by mtsCommandQueuedWrite< _argumentType >::Execute().

---

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

• mtsQueue.h

---