API Documentation
Loading...
Searching...
No Matches
BitIterator Class Reference

Simple bit iterator, typically used for parsing Buffer of bools in loops. More...

#include <BitIterator.hpp>

Public Member Functions

 BitIterator (BitFlag *flag, const sint04 offset)
 
 BitIterator (const BitIterator &iter)=default
 
constexpr operator bool () const
 
bool operator! () const
 
bool operator!= (const BitIterator &rawIterator) const
 
BitReference operator* ()
 
const BitReference operator* () const
 
template<class t_type >
BitIterator operator+ (t_type distance) const
 
BitIteratoroperator++ ()
 
BitIterator operator++ (int)
 
template<class t_type >
BitIteratoroperator+= (const t_type &movement)
 
ptrdiff_t operator- (const BitIterator &rawIterator)
 
template<class t_type >
BitIterator operator- (t_type distance) const
 
BitIteratoroperator-- ()
 
BitIterator operator-- (int)
 
template<class t_type >
BitIteratoroperator-= (const t_type &movement)
 
bool operator< (const BitIterator &other) const
 
BitIteratoroperator= (const BitIterator &rawIterator)=default
 
bool operator== (const BitIterator &rawIterator) const
 
bool operator> (const BitIterator &other) const
 

Detailed Description

Simple bit iterator, typically used for parsing Buffer of bools in loops.


Constructor & Destructor Documentation

◆ BitIterator() [1/2]

BitIterator ( BitFlag * flag,
const sint04 offset )
inline

◆ BitIterator() [2/2]

BitIterator ( const BitIterator & iter)
default

Member Function Documentation

◆ operator bool()

operator bool ( ) const
inlineconstexpr

◆ operator!()

bool operator! ( ) const
inline

◆ operator!=()

bool operator!= ( const BitIterator & rawIterator) const
inline

◆ operator*() [1/2]

BitReference operator* ( )
inline

◆ operator*() [2/2]

const BitReference operator* ( ) const
inline

◆ operator+()

template<class t_type >
BitIterator operator+ ( t_type distance) const
inline

◆ operator++() [1/2]

BitIterator & operator++ ( )
inline

◆ operator++() [2/2]

BitIterator operator++ ( int )
inline

◆ operator+=()

template<class t_type >
BitIterator & operator+= ( const t_type & movement)
inline

◆ operator-() [1/2]

ptrdiff_t operator- ( const BitIterator & rawIterator)
inline

◆ operator-() [2/2]

template<class t_type >
BitIterator operator- ( t_type distance) const
inline

◆ operator--() [1/2]

BitIterator & operator-- ( )
inline

◆ operator--() [2/2]

BitIterator operator-- ( int )
inline

◆ operator-=()

template<class t_type >
BitIterator & operator-= ( const t_type & movement)
inline

◆ operator<()

bool operator< ( const BitIterator & other) const
inline

◆ operator=()

BitIterator & operator= ( const BitIterator & rawIterator)
default

◆ operator==()

bool operator== ( const BitIterator & rawIterator) const
inline

◆ operator>()

bool operator> ( const BitIterator & other) const
inline

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