Fw::FifoQueue< T, C > Class Template Reference

#include <Fw/DataStructures/FifoQueue.hpp>

Inheritance diagram for Fw::FifoQueue< T, C >:

Public Member Functions
	FifoQueue ()
	Zero-argument constructor. More...
	FifoQueue (const FifoQueue< T, C > &queue)
	Copy constructor. More...
	~FifoQueue () override=default
	Destructor. More...
FifoQueue< T, C > &	operator= (const FifoQueue< T, C > &queue)
	operator= More...
void	clear () override
	Clear the queue. More...
Success	enqueue (const T &e) override
Success	dequeue (T &e) override
FwSizeType	getSize () const override
FwSizeType	getCapacity () const override
const T &	at (FwSizeType index) const override
Public Member Functions inherited from Fw::FifoQueueBase< T >
void	copyDataFrom (const FifoQueueBase< T > &queue)
	Copy data from another queue. More...
Success	peek (T &e, FwSizeType index=0) const
Public Member Functions inherited from Fw::SizedContainer
bool	isEmpty () const
bool	isFull () const

Friends
template<typename TT , FwSizeType CC>
class	FifoQueueTester

Additional Inherited Members
Protected Member Functions inherited from Fw::FifoQueueBase< T >
	FifoQueueBase ()
	Zero-argument constructor. More...
virtual	~FifoQueueBase ()=default
	Destructor. More...
Protected Member Functions inherited from Fw::SizedContainer
	SizedContainer ()
	Zero-argument constructor. More...
virtual	~SizedContainer ()=default
	Destructor. More...

Detailed Description

template<typename T, FwSizeType C>
class Fw::FifoQueue< T, C >

Definition at line 16 of file FifoQueue.hpp.

Constructor & Destructor Documentation

FifoQueue() [1/2]

template<typename T, FwSizeType C>

Fw::FifoQueue< T, C >::FifoQueue ( )

inline

Zero-argument constructor.

Definition at line 37 of file FifoQueue.hpp.

FifoQueue() [2/2]

template<typename T, FwSizeType C>

Fw::FifoQueue< T, C >::FifoQueue ( const FifoQueue< T, C > &  queue )

inline

Copy constructor.

Definition at line 40 of file FifoQueue.hpp.

~FifoQueue()

template<typename T, FwSizeType C>

Fw::FifoQueue< T, C >::~FifoQueue ( )

overridedefault

Destructor.

Member Function Documentation

at()

template<typename T, FwSizeType C>

const T& Fw::FifoQueue< T, C >::at ( FwSizeType  index ) const

inlineoverridevirtual

Get an item at an index. Indices go from left to right in the queue. Fails an assertion if the index is out of range.

Returns

The item

Parameters

index

The index

Implements Fw::FifoQueueBase< T >.

Definition at line 85 of file FifoQueue.hpp.

clear()

template<typename T, FwSizeType C>

void Fw::FifoQueue< T, C >::clear ( )

inlineoverridevirtual

Clear the queue.

Implements Fw::SizedContainer.

Definition at line 57 of file FifoQueue.hpp.

dequeue()

template<typename T, FwSizeType C>

Success Fw::FifoQueue< T, C >::dequeue ( T &  e )

inlineoverridevirtual

Dequeue an item (remove from the left)

Returns

SUCCESS if item dequeued

Parameters

e	The item (output)

Implements Fw::FifoQueueBase< T >.

Definition at line 68 of file FifoQueue.hpp.

enqueue()

template<typename T, FwSizeType C>

Success Fw::FifoQueue< T, C >::enqueue ( const T &  e )

inlineoverridevirtual

Enqueue an item (push on the right)

Returns

SUCCESS if item enqueued

Parameters

e	The item (output)

Implements Fw::FifoQueueBase< T >.

Definition at line 61 of file FifoQueue.hpp.

getCapacity()

template<typename T, FwSizeType C>

FwSizeType Fw::FifoQueue< T, C >::getCapacity ( ) const

inlineoverridevirtual

Get the capacity (maximum number of items stored in the queue)

Returns

The capacity

Implements Fw::SizedContainer.

Definition at line 79 of file FifoQueue.hpp.

getSize()

template<typename T, FwSizeType C>

FwSizeType Fw::FifoQueue< T, C >::getSize ( ) const

inlineoverridevirtual

Get the size (number of items stored in the queue)

Returns

The size

Implements Fw::SizedContainer.

Definition at line 75 of file FifoQueue.hpp.

operator=()

template<typename T, FwSizeType C>

FifoQueue<T, C>& Fw::FifoQueue< T, C >::operator= ( const FifoQueue< T, C > &  queue )

inline

operator=

Definition at line 51 of file FifoQueue.hpp.

Friends And Related Function Documentation

FifoQueueTester

template<typename T, FwSizeType C>

template<typename TT , FwSizeType CC>

friend class FifoQueueTester

friend

Definition at line 21 of file FifoQueue.hpp.

---

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

• Fw/DataStructures/FifoQueue.hpp