QueueBase Class Reference

Base Queue Wrapper. More...

#include <QueueCPP.h>

Inheritance diagram for QueueBase:

Collaboration diagram for QueueBase:

Public Member Functions
virtual	~QueueBase ()
	Destructor.
unsigned	available () const
	Return number of spaces available in Queue.
bool	empty ()
	Check if Queue is Empty.
bool	empty_ISR ()
	Is Queue Empty.
bool	full ()
	Check if Queue is Full.
bool	full_ISR ()
	Is Queue Full.
void	reset ()
	Reset the Queue.
unsigned	waiting () const
	Get number of items in the Queue.
unsigned	waiting_ISR ()
	Get number of message waiting.

Protected Member Functions
	QueueBase (QueueHandle_t handle_)
	Constructor.

Protected Attributes
QueueHandle_t	queueHandle

Private Member Functions
	QueueBase (QueueBase const &)=delete
	We are not copyable.
void	operator= (QueueBase const &)=delete
	We are not assignable.

Detailed Description

Base Queue Wrapper.

This Base Class provides the Type Independent functionality for a Queue

Constructor & Destructor Documentation

QueueBase() [1/2]

QueueBase::QueueBase ( QueueHandle_t handle_ )

inlineprotected

Constructor.

Effectively Abstract class so protected base.

Parameters

handle_

The queueHandle for the queue/

~QueueBase()

virtual QueueBase::~QueueBase ( )

inlinevirtual

Destructor.

QueueBase() [2/2]

QueueBase::QueueBase ( QueueBase const & )

privatedelete

We are not copyable.

Member Function Documentation

available()

unsigned QueueBase::available ( ) const

inline

Return number of spaces available in Queue.

Returns

the number of spaces available in the Queue.

empty()

bool QueueBase::empty ( )

inline

Check if Queue is Empty.

Returns

True if Queue is Empty.

empty_ISR()

bool QueueBase::empty_ISR ( )

inline

Is Queue Empty.

Note: Interrupt service routines should only call _ISR routines.

Returns

True if Queue is Empty.

full()

bool QueueBase::full ( )

inline

Check if Queue is Full.

Returns

True if Queue is Full.

full_ISR()

bool QueueBase::full_ISR ( )

inline

Is Queue Full.

Note: Interrupt service routines should only call _ISR routines.

Returns

True if Queue is Full.

operator=()

void QueueBase::operator= ( QueueBase const & )

privatedelete

We are not assignable.

reset()

void QueueBase::reset ( )

inline

Reset the Queue.

Resets the Queue to an empty state.

waiting()

unsigned QueueBase::waiting ( ) const

inline

Get number of items in the Queue.

Returns

The number of item in the Queue.

waiting_ISR()

unsigned QueueBase::waiting_ISR ( )

inline

Get number of message waiting.

Note: Interrupt service routines should only call _ISR routines.

Returns

The number of messages waiting.

Member Data Documentation

queueHandle

QueueHandle_t QueueBase::queueHandle

protected

---

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

• QueueCPP.h