Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Friends
gmx::SelectionParserSymbolIterator Class Reference

#include <gromacs/selection/symrec.h>

Description

Input iterator for iterating symbols of a given type.

Behaves as standard C++ input iterator. To get an iterator, call SelectionParserSymbolTable::beginIterator(). Each time the iterator is incremented, it moves to the next symbol of the type given when the iterator was created. When there are no more symbols, the iterator will equal SelectionParserSymbolTable::endIterator(). It is not allowed to dereference or increment an iterator that has reached the end.

Construction and assignment may throw std::bad_alloc if out of memory. Other methods do not throw.

See Also
SelectionParserSymbolTable::beginIterator()

Classes

class  Impl
 Private implementation class for SelectionParserSymbolIterator. More...
 

Public Types

Iterator type traits

Satisfies the requirements for STL input iterator.

using iterator_category = std::input_iterator_tag
 
using value_type = const SelectionParserSymbol
 
using difference_type = std::ptrdiff_t
 
using pointer = const SelectionParserSymbol *
 
using reference = const SelectionParserSymbol &
 

Public Member Functions

 SelectionParserSymbolIterator (const SelectionParserSymbolIterator &other)
 Creates an independent copy of an iterator.
 
SelectionParserSymbolIteratoroperator= (const SelectionParserSymbolIterator &other)
 Creates an independent copy of an iterator.
 
bool operator== (const SelectionParserSymbolIterator &other) const
 Equality comparison for iterators.
 
bool operator!= (const SelectionParserSymbolIterator &other) const
 Inequality comparison for iterators.
 
reference operator* () const
 Dereferences the iterator.
 
pointer operator-> () const
 Dereferences the iterator.
 
SelectionParserSymbolIteratoroperator++ ()
 Moves the iterator to the next symbol.
 
SelectionParserSymbolIterator operator++ (int)
 Moves the iterator to the next symbol.
 

Friends

class SelectionParserSymbolTable
 Needed to access the constructor.
 

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