xsens::FifoQueue< T, E > Class Template Reference

A FIFO queue with limited length (cyclic). More...

#include <xsens_fifoqueue.h>

Public Types
typedef T	value_type
	The type of the value stored in this queue. More...
typedef size_t	size_type
	The type of a 'size' value. More...

Public Member Functions
	FifoQueue (size_type size=16, bool delOnOverwrite=true)
	Create an empty queue with capacity size. More...
template<bool E2>
	FifoQueue (const FifoQueue< T, E2 > &q)
	The copy constructor. More...
void	eraseAndClear (void)
	~FifoQueue ()
	The destructor. More...
template<bool E2>
FifoQueue< T, E > &	operator= (const FifoQueue< T, E2 > &q)
	The assignment operator. More...
void	resize (const size_t size)
	Resize the queue, note that this function clears the queue. More...
bool	empty () const
	Return true if the queue is empty. More...
size_type	size () const
	Return the maximum number of elements in the queue. More...
size_type	length () const
	Return the number of elements currnetly in the queue. More...
value_type &	front ()
	Return the oldest element in the queue. More...
const value_type &	front () const
	Return the oldest element in the queue. More...
value_type &	back ()
	Return the newest element in the queue. More...
const value_type &	back () const
	Return the newest element in the queue. More...
void	push (const value_type &x)
	Insert x at the back of the queue. More...
void	pop (void)
	Remove the element at the front of the queue. More...
void	popBack (void)
	Remove the element at the back of the queue. More...
const value_type &	operator[] (size_t index) const
	Return the index'th oldest item from the queue. More...
value_type &	operator[] (size_t index)
	Return the index'th oldest item from the queue. More...
void	clear (void)
void	remove (size_t index)

Protected Attributes
size_t	m_maxCount
size_t	m_currentCount
size_t	m_first
bool	m_deleteOnOverwrite
T *	m_list

Detailed Description

template<class T, bool E = true>
class xsens::FifoQueue< T, E >

A FIFO queue with limited length (cyclic).

The class is based on the STL queue class, but has a limited size. If more items are inserted than would fit, the oldest item is overwritten. The class can only handle pointer types.

Member Typedef Documentation

template<class T, bool E = true>

typedef size_t xsens::FifoQueue< T, E >::size_type

The type of a 'size' value.

template<class T, bool E = true>

typedef T xsens::FifoQueue< T, E >::value_type

The type of the value stored in this queue.

Constructor & Destructor Documentation

template<class T, bool E = true>

xsens::FifoQueue< T, E >::FifoQueue ( size_type  size = 16, bool  delOnOverwrite = true  )

inline

Create an empty queue with capacity size.

template<class T, bool E = true>

template<bool E2>

xsens::FifoQueue< T, E >::FifoQueue ( const FifoQueue< T, E2 > &  q )

inline

The copy constructor.

template<class T, bool E = true>

xsens::FifoQueue< T, E >::~FifoQueue ( )

inline

The destructor.

Member Function Documentation

template<class T, bool E = true>

value_type& xsens::FifoQueue< T, E >::back ( )

inline

Return the newest element in the queue.

template<class T, bool E = true>

const value_type& xsens::FifoQueue< T, E >::back ( ) const

inline

Return the newest element in the queue.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::clear ( void  )

inline

template<class T, bool E = true>

bool xsens::FifoQueue< T, E >::empty ( ) const

inline

Return true if the queue is empty.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::eraseAndClear ( void  )

inline

template<class T, bool E = true>

value_type& xsens::FifoQueue< T, E >::front ( )

inline

Return the oldest element in the queue.

template<class T, bool E = true>

const value_type& xsens::FifoQueue< T, E >::front ( ) const

inline

Return the oldest element in the queue.

template<class T, bool E = true>

size_type xsens::FifoQueue< T, E >::length ( ) const

inline

Return the number of elements currnetly in the queue.

template<class T, bool E = true>

template<bool E2>

FifoQueue<T,E>& xsens::FifoQueue< T, E >::operator= ( const FifoQueue< T, E2 > &  q )

inline

The assignment operator.

template<class T, bool E = true>

const value_type& xsens::FifoQueue< T, E >::operator[] ( size_t  index ) const

inline

Return the index'th oldest item from the queue.

template<class T, bool E = true>

value_type& xsens::FifoQueue< T, E >::operator[] ( size_t  index )

inline

Return the index'th oldest item from the queue.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::pop ( void  )

inline

Remove the element at the front of the queue.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::popBack ( void  )

inline

Remove the element at the back of the queue.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::push ( const value_type &  x )

inline

Insert x at the back of the queue.

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::remove ( size_t  index )

inline

template<class T, bool E = true>

void xsens::FifoQueue< T, E >::resize ( const size_t  size )

inline

Resize the queue, note that this function clears the queue.

template<class T, bool E = true>

size_type xsens::FifoQueue< T, E >::size ( ) const

inline

Return the maximum number of elements in the queue.

Member Data Documentation

template<class T, bool E = true>

size_t xsens::FifoQueue< T, E >::m_currentCount

protected

template<class T, bool E = true>

bool xsens::FifoQueue< T, E >::m_deleteOnOverwrite

protected

template<class T, bool E = true>

size_t xsens::FifoQueue< T, E >::m_first

protected

template<class T, bool E = true>

T* xsens::FifoQueue< T, E >::m_list

protected

template<class T, bool E = true>

size_t xsens::FifoQueue< T, E >::m_maxCount

protected

---

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

• /build/rock-master-18.09-drivers-xsens-imu-0.20180621/external/xsensVendorLib/xsens_fifoqueue.h