FreeRTOScpp::QueueBase Class Reference

Base Queue Wrapper. More...

#include <QueueCPP.h>

Inheritance diagram for FreeRTOScpp::QueueBase:

Collaboration diagram for FreeRTOScpp::QueueBase:

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

Protected Member Functions
	QueueBase (QueueHandle_t handle_)
	Constructor. More...

Protected Attributes
QueueHandle_t	queueHandle

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

Detailed Description

Base Queue Wrapper.

This Base Class provides the Type Independent functionality for a Queue

Constructor & Destructor Documentation

QueueBase() [1/2]

FreeRTOScpp::QueueBase::QueueBase ( QueueHandle_t  handle_ )

inlineprotected

Constructor.

Effectively Abstract class so protected base.

Parameters

handle_

The queueHandle for the queue/

~QueueBase()

virtual FreeRTOScpp::QueueBase::~QueueBase ( )

inlinevirtual

Destructor.

References queueHandle.

QueueBase() [2/2]

FreeRTOScpp::QueueBase::QueueBase ( QueueBase const &  )

privatedelete

We are not copyable.

Member Function Documentation

available()

unsigned FreeRTOScpp::QueueBase::available ( ) const

inline

Return number of spaces available in Queue.

Returns

the number of spaces available in the Queue.

References queueHandle.

empty()

bool FreeRTOScpp::QueueBase::empty ( )

inline

Check if Queue is Empty.

Returns

True if Queue is Empty.

References queueHandle.

empty_ISR()

bool FreeRTOScpp::QueueBase::empty_ISR ( )

inline

Is Queue Empty.

Note: Interrupt service routines should only call _ISR routines.

Returns

True if Queue is Empty.

References queueHandle.

full()

bool FreeRTOScpp::QueueBase::full ( )

inline

Check if Queue is Full.

Returns

True if Queue is Full.

References queueHandle.

full_ISR()

bool FreeRTOScpp::QueueBase::full_ISR ( )

inline

Is Queue Full.

Note: Interrupt service routines should only call _ISR routines.

Returns

True if Queue is Full.

References queueHandle.

operator=()

void FreeRTOScpp::QueueBase::operator= ( QueueBase const &  )

privatedelete

We are not assignable.

reset()

void FreeRTOScpp::QueueBase::reset ( )

inline

Reset the Queue.

Resets the Queue to an empty state.

References queueHandle.

waiting()

unsigned FreeRTOScpp::QueueBase::waiting ( ) const

inline

Get number of items in the Queue.

Returns

The number of item in the Queue.

References queueHandle.

waiting_ISR()

unsigned FreeRTOScpp::QueueBase::waiting_ISR ( )

inline

Get number of message waiting.

Note: Interrupt service routines should only call _ISR routines.

Returns

The number of messages waiting.

References queueHandle.

Member Data Documentation

queueHandle

QueueHandle_t FreeRTOScpp::QueueBase::queueHandle

protected

Referenced by FreeRTOScpp::QueueTypeBase< T >::add(), FreeRTOScpp::QueueTypeBase< T >::add_ISR(), available(), empty(), empty_ISR(), full(), full_ISR(), FreeRTOScpp::QueueTypeBase< T >::peek(), FreeRTOScpp::QueueTypeBase< T >::peek_ISR(), FreeRTOScpp::QueueTypeBase< T >::pop(), FreeRTOScpp::QueueTypeBase< T >::pop_ISR(), FreeRTOScpp::QueueTypeBase< T >::push(), FreeRTOScpp::QueueTypeBase< T >::push_ISR(), FreeRTOScpp::Queue< T, queueLength >::Queue(), reset(), waiting(), waiting_ISR(), and ~QueueBase().

---

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

• QueueCPP.h