Hymn to Beauty
C++ 3D Engine
Utility::Queue< T > Class Template Reference

Queue container class. More...

#include <Queue.hpp>

Public Member Functions

 Queue ()=default
 Constructor. More...
 
 ~Queue ()
 Destrcutor. More...
 
void Push (const T &val)
 Push value at back of queue. More...
 
T * Front ()
 Get value at front of queue. More...
 
T * Back ()
 Get value at back of queue. More...
 
void Pop ()
 Remove value at front of queue. More...
 
bool Empty () const
 Check if queue is empty. More...
 
T * Iterate ()
 Iterate over all values in queue. More...
 
unsigned int Size () const
 Get the number of elements in queue. More...
 

Detailed Description

template<typename T>
class Utility::Queue< T >

Queue container class.

Constructor & Destructor Documentation

◆ Queue()

template<typename T >
Utility::Queue< T >::Queue ( )
default

Constructor.

◆ ~Queue()

template<typename T >
Utility::Queue< T >::~Queue

Destrcutor.

Member Function Documentation

◆ Back()

template<typename T >
T * Utility::Queue< T >::Back

Get value at back of queue.

Returns
Value at back of queue.

◆ Empty()

template<typename T >
bool Utility::Queue< T >::Empty

Check if queue is empty.

Returns
Whether queue is empty or not.

◆ Front()

template<typename T >
T * Utility::Queue< T >::Front

Get value at front of queue.

Returns
Value at front of queue.

◆ Iterate()

template<typename T >
T * Utility::Queue< T >::Iterate

Iterate over all values in queue.

Returns
Value from queue (nullptr if end).

◆ Pop()

template<typename T >
void Utility::Queue< T >::Pop

Remove value at front of queue.

◆ Push()

template<typename T >
void Utility::Queue< T >::Push ( const T &  val)

Push value at back of queue.

Parameters
valValue to push.

◆ Size()

template<typename T >
unsigned int Utility::Queue< T >::Size

Get the number of elements in queue.

Returns
Number of elements in queue.

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