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

A convenience class used with Buffers or Vectors of bools for referencing or acting on a single bit. More...

#include <BitReference.hpp>

Public Member Functions

constexpr BitReference (BitFlag &flag, uint01 bit)
 
constexpr BitReference (const BitReference &reference)
 
constexpr bool get () const
 
constexpr operator bool () const
 
constexpr bool operator! () const
 
constexpr bool operator!= (const bool &b) const
 
constexpr BitReferenceoperator= (const BitReference &b)
 
constexpr BitReferenceoperator= (const bool &b)
 
constexpr bool operator== (const bool &b) const
 
constexpr BitReferenceoperator|= (const BitReference &b)
 
constexpr BitReferenceoperator|= (const bool &b)
 
constexpr void set (const bool &value)
 

Detailed Description

A convenience class used with Buffers or Vectors of bools for referencing or acting on a single bit.


Constructor & Destructor Documentation

◆ BitReference() [1/2]

BitReference ( BitFlag & flag,
uint01 bit )
inlineconstexpr

◆ BitReference() [2/2]

BitReference ( const BitReference & reference)
inlineconstexpr

Member Function Documentation

◆ get()

bool get ( ) const
inlinenodiscardconstexpr

◆ operator bool()

operator bool ( ) const
inlineconstexpr

◆ operator!()

bool operator! ( ) const
inlineconstexpr

◆ operator!=()

bool operator!= ( const bool & b) const
inlineconstexpr

◆ operator=() [1/2]

BitReference & operator= ( const BitReference & b)
inlineconstexpr

◆ operator=() [2/2]

BitReference & operator= ( const bool & b)
inlineconstexpr

◆ operator==()

bool operator== ( const bool & b) const
inlineconstexpr

◆ operator|=() [1/2]

BitReference & operator|= ( const BitReference & b)
inlineconstexpr

◆ operator|=() [2/2]

BitReference & operator|= ( const bool & b)
inlineconstexpr

◆ set()

void set ( const bool & value)
inlineconstexpr

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