OpenXLSX 1.9.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions
OpenXLSX::XLRowIterator Class Reference

#include <XLRow.hpp>

Public Types

using iterator_category = std::forward_iterator_tag
 
using value_type = XLRow
 
using difference_type = int64_t
 
using pointer = XLRow *
 
using reference = XLRow &
 

Public Member Functions

 XLRowIterator (const XLRowRange &rowRange, XLIteratorLocation loc)
 
 ~XLRowIterator ()
 
 XLRowIterator (const XLRowIterator &other)
 
 XLRowIterator (XLRowIterator &&other) noexcept
 
XLRowIterator & operator= (const XLRowIterator &other)
 
XLRowIterator & operator= (XLRowIterator &&other) noexcept
 
XLRowIterator & operator++ ()
 
XLRowIterator operator++ (int)
 
reference operator* ()
 
pointer operator-> ()
 
bool operator== (const XLRowIterator &rhs) const
 
bool operator!= (const XLRowIterator &rhs) const
 
 operator bool () const
 
bool rowExists ()
 determine whether the row that the iterator points to exists (m_currentRowNumber)
 
bool endReached () const
 determine whether iterator is at 1 beyond the last row in range
 
uint32_t rowNumber () const
 get the row number corresponding to the current iterator position
 

Member Typedef Documentation

◆ difference_type

using OpenXLSX::XLRowIterator::difference_type = int64_t

◆ iterator_category

using OpenXLSX::XLRowIterator::iterator_category = std::forward_iterator_tag

◆ pointer

using OpenXLSX::XLRowIterator::pointer = XLRow*

◆ reference

using OpenXLSX::XLRowIterator::reference = XLRow&

◆ value_type

using OpenXLSX::XLRowIterator::value_type = XLRow

Constructor & Destructor Documentation

◆ XLRowIterator() [1/3]

OpenXLSX::XLRowIterator::XLRowIterator ( const XLRowRange &  rowRange,
XLIteratorLocation  loc 
)
explicit
Parameters
rowRange
loc

◆ ~XLRowIterator()

OpenXLSX::XLRowIterator::~XLRowIterator ( )
default

◆ XLRowIterator() [2/3]

OpenXLSX::XLRowIterator::XLRowIterator ( const XLRowIterator &  other)
Parameters
other

◆ XLRowIterator() [3/3]

OpenXLSX::XLRowIterator::XLRowIterator ( XLRowIterator &&  other)
defaultnoexcept
Parameters
other

Member Function Documentation

◆ endReached()

bool OpenXLSX::XLRowIterator::endReached ( ) const
inline

determine whether iterator is at 1 beyond the last row in range

Returns

◆ operator bool()

OpenXLSX::XLRowIterator::operator bool ( ) const
explicit
Returns

◆ operator!=()

bool OpenXLSX::XLRowIterator::operator!= ( const XLRowIterator &  rhs) const
Parameters
rhs
Returns

◆ operator*()

XLRow & OpenXLSX::XLRowIterator::operator* ( )
Returns

◆ operator++() [1/2]

XLRowIterator & OpenXLSX::XLRowIterator::operator++ ( )
Returns

◆ operator++() [2/2]

XLRowIterator OpenXLSX::XLRowIterator::operator++ ( int  )
Returns

◆ operator->()

XLRowIterator::pointer OpenXLSX::XLRowIterator::operator-> ( )
Returns

◆ operator=() [1/2]

XLRowIterator & OpenXLSX::XLRowIterator::operator= ( const XLRowIterator &  other)
Parameters
other
Returns

◆ operator=() [2/2]

XLRowIterator & OpenXLSX::XLRowIterator::operator= ( XLRowIterator &&  other)
defaultnoexcept
Parameters
other
Returns

◆ operator==()

bool OpenXLSX::XLRowIterator::operator== ( const XLRowIterator &  rhs) const
Parameters
rhs
Returns

◆ rowExists()

bool OpenXLSX::XLRowIterator::rowExists ( )

determine whether the row that the iterator points to exists (m_currentRowNumber)

Returns
true if XML already has an entry for that cell, otherwise false

◆ rowNumber()

uint32_t OpenXLSX::XLRowIterator::rowNumber ( ) const
inline

get the row number corresponding to the current iterator position

Returns
a row number, with m_lastRow + 1 for the beyond-the-end iterator
The documentation for this class was generated from the following files: