Loading...
Searching...
No Matches
CircularBuffer< T >::const_iterator Class Reference

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

#include <CircularBuffer.H>

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 558 of file CircularBuffer.H.

Member Typedef Documentation

◆ difference_type

template<class T>
using difference_type = label

Definition at line 565 of file CircularBuffer.H.

◆ value_type

template<class T>
using value_type = const T

Definition at line 566 of file CircularBuffer.H.

◆ pointer

template<class T>
using pointer = const T*

Definition at line 567 of file CircularBuffer.H.

◆ reference

template<class T>
using reference = const T&

Definition at line 568 of file CircularBuffer.H.

◆ iterator_category

template<class T>
using iterator_category = std::forward_iterator_tag

Definition at line 569 of file CircularBuffer.H.

Constructor & Destructor Documentation

◆ const_iterator() [1/2]

template<class T>
const_iterator ( const const_iterator & )
default

References const_iterator().

Referenced by const_iterator(), operator!=(), operator++(), operator++(), operator=(), and operator==().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ const_iterator() [2/2]

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

Definition at line 574 of file CircularBuffer.H.

References CircularBuffer< T >::CircularBuffer().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

template<class T>
const_iterator & operator= ( const const_iterator & )
default

References const_iterator().

Here is the call graph for this function:

◆ operator*()

template<class T>
reference operator* ( ) const
inline

Definition at line 584 of file CircularBuffer.H.

◆ operator++() [1/2]

template<class T>
const_iterator & operator++ ( )
inline

Definition at line 589 of file CircularBuffer.H.

References const_iterator().

Here is the call graph for this function:

◆ operator++() [2/2]

template<class T>
const_iterator operator++ ( int )
inline

Definition at line 595 of file CircularBuffer.H.

References const_iterator().

Here is the call graph for this function:

◆ operator==()

template<class T>
bool operator== ( const const_iterator & rhs) const
inline

Definition at line 602 of file CircularBuffer.H.

References const_iterator(), and Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

template<class T>
bool operator!= ( const const_iterator & rhs) const
inline

Definition at line 607 of file CircularBuffer.H.

References const_iterator(), and Foam::rhs().

Here is the call graph for this function:
The documentation for this class was generated from the following file: