Public Types | Public Member Functions | List of all members
CircularBuffer< T >::const_iterator Class Reference

A simple forward const iterator for a circular buffer. More...

Public Types

using difference_type = label
 
using value_type = const T
 
using pointer = const T *
 
using reference = const T &
 
using iterator_category = std::forward_iterator_tag
 

Public Member Functions

 const_iterator (const const_iterator &)=default
 
const_iterator & operator= (const const_iterator &)=default
 
 const_iterator (const CircularBuffer< T > *buffer, label i)
 
reference operator* () const
 
const_iterator & operator++ ()
 
const_iterator operator++ (int)
 
bool operator== (const const_iterator &rhs) const
 
bool operator!= (const const_iterator &rhs) const
 

Detailed Description

template<class T>
class Foam::CircularBuffer< T >::const_iterator

A simple forward const iterator for a circular buffer.

Definition at line 402 of file CircularBuffer.H.

Member Typedef Documentation

◆ difference_type

using difference_type = label

Definition at line 409 of file CircularBuffer.H.

◆ value_type

using value_type = const T

Definition at line 410 of file CircularBuffer.H.

◆ pointer

using pointer = const T*

Definition at line 411 of file CircularBuffer.H.

◆ reference

using reference = const T&

Definition at line 412 of file CircularBuffer.H.

◆ iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 413 of file CircularBuffer.H.

Constructor & Destructor Documentation

◆ const_iterator() [1/2]

const_iterator ( const const_iterator &  )
default

◆ const_iterator() [2/2]

const_iterator ( const CircularBuffer< T > *  buffer,
label  i 
)
inline

Definition at line 418 of file CircularBuffer.H.

Member Function Documentation

◆ operator=()

const_iterator & operator= ( const const_iterator &  )
default

◆ operator*()

reference operator* ( ) const
inline

Definition at line 428 of file CircularBuffer.H.

◆ operator++() [1/2]

const_iterator & operator++ ( )
inline

Definition at line 433 of file CircularBuffer.H.

◆ operator++() [2/2]

const_iterator operator++ ( int  )
inline

Definition at line 439 of file CircularBuffer.H.

◆ operator==()

bool operator== ( const const_iterator &  rhs) const
inline

Definition at line 446 of file CircularBuffer.H.

◆ operator!=()

bool operator!= ( const const_iterator &  rhs) const
inline

Definition at line 451 of file CircularBuffer.H.

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