ERC CISST - cisst software

---

mtsQueueGeneric Class Reference

Collaboration diagram for mtsQueueGeneric:

[legend]List of all members.

---

Detailed Description

Definition at line 198 of file 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 Function Documentation

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

Definition at line 280 of file mtsQueue.h.

References Allocate(), ClassServices, CMN_LOG_INIT_WARNING, Free(), cmnClassServicesBase::GetName(), and cmnGenericObject::Services().

size_type mtsQueueGeneric::GetSize

(

void

)

const [inline]

Returns size of queue.

Definition at line 299 of file mtsQueue.h.

References Size.

size_type mtsQueueGeneric::GetAvailable

(

void

)

const [inline]

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

Definition at line 306 of file mtsQueue.h.

References Head, Size, and Tail.

bool mtsQueueGeneric::IsFull

(

void

)

const [inline]

Returns true if queue is full.

Definition at line 317 of file mtsQueue.h.

References Data, Head, and Tail.

bool mtsQueueGeneric::IsEmpty

(

void

)

const [inline]

Returns true if queue is empty.

Definition at line 327 of file mtsQueue.h.

References Head, and Tail.

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

Definition at line 336 of file mtsQueue.h.

References CMN_LOG_RUN_ERROR, Data, cmnClassServicesBase::GetName(), Head, and cmnGenericObject::Services().

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

Definition at line 362 of file mtsQueue.h.

References Tail.

pointer mtsQueueGeneric::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 373 of file mtsQueue.h.

References Data, and Tail.

---

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

• mtsQueue.h

---