OpenMD  2.5
Molecular Dynamics in the Open
antlr::CircularQueue< T > Class Template Reference

#include <CircularQueue.hpp>

Public Member Functions

 CircularQueue ()
 
 ~CircularQueue ()
 
void clear (void)
 Clear the queue. More...
 
elementAt (size_t idx) const
 
void removeFirst ()
 
void removeItems (size_t nb)
 
void append (const T &t)
 
size_t entries () const
 

Private Member Functions

 CircularQueue (const CircularQueue &)
 
const CircularQueueoperator= (const CircularQueue &)
 

Private Attributes

std ::vector< T > storage
 
size_t m_offset
 

Detailed Description

template<class T>
class antlr::CircularQueue< T >

Definition at line 24 of file CircularQueue.hpp.

Constructor & Destructor Documentation

◆ CircularQueue() [1/2]

template<class T>
antlr::CircularQueue< T >::CircularQueue ( )
inline

Definition at line 26 of file CircularQueue.hpp.

◆ ~CircularQueue()

template<class T>
antlr::CircularQueue< T >::~CircularQueue ( )
inline

Definition at line 31 of file CircularQueue.hpp.

◆ CircularQueue() [2/2]

template<class T>
antlr::CircularQueue< T >::CircularQueue ( const CircularQueue< T > &  )
private

Member Function Documentation

◆ append()

template<class T>
void antlr::CircularQueue< T >::append ( const T &  t)
inline

Definition at line 79 of file CircularQueue.hpp.

Referenced by antlr::InputBuffer::fill().

◆ clear()

template<class T>
void antlr::CircularQueue< T >::clear ( void  )
inline

Clear the queue.

Definition at line 36 of file CircularQueue.hpp.

◆ elementAt()

template<class T>
T antlr::CircularQueue< T >::elementAt ( size_t  idx) const
inline
Todo:
this should use at or should have a check

Definition at line 43 of file CircularQueue.hpp.

Referenced by antlr::InputBuffer::getLAChars(), and antlr::InputBuffer::getMarkedChars().

◆ entries()

template<class T>
size_t antlr::CircularQueue< T >::entries ( ) const
inline

◆ operator=()

template<class T>
const CircularQueue& antlr::CircularQueue< T >::operator= ( const CircularQueue< T > &  )
private

◆ removeFirst()

template<class T>
void antlr::CircularQueue< T >::removeFirst ( )
inline

Definition at line 47 of file CircularQueue.hpp.

◆ removeItems()

template<class T>
void antlr::CircularQueue< T >::removeItems ( size_t  nb)
inline

Definition at line 57 of file CircularQueue.hpp.

Member Data Documentation

◆ m_offset

template<class T>
size_t antlr::CircularQueue< T >::m_offset
private

Definition at line 90 of file CircularQueue.hpp.

◆ storage

template<class T>
std ::vector<T> antlr::CircularQueue< T >::storage
private

Definition at line 89 of file CircularQueue.hpp.


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