bitSet::reference Class Reference

A reference supporting read/write access to an entry. More...

#include <bitSet.H>

Inheritance diagram for bitSet::reference:

Collaboration diagram for bitSet::reference:

Public Member Functions
	reference (const reference &) noexcept=default
	Copy construct.
	reference (reference &&) noexcept=default
	Move construct.
void	flip ()
	Flip the bit at the position, no range-checking.
void	operator= (const reference &other)
	Value assignment.
void	operator= (const unsigned int val)
	Value assignment.
	operator unsigned int () const
	Conversion operator.
Public Member Functions inherited from PackedList< Width >::reference
	reference (const reference &) noexcept=default
	Copy construct.
	reference (reference &&) noexcept=default
	Move construct.
void	operator= (const reference &other)
	Value assignment.
void	operator= (const unsigned int val)
	Value assignment.
	operator unsigned int () const
	Conversion operator.

Protected Member Functions
void	operator& ()=delete
	reference (bitSet *parent, const label index)
	Construct by taking reference of block from within the list and the specified index.
Protected Member Functions inherited from PackedList< Width >::reference
void	operator& ()=delete
	reference (PackedList *parent, const label index)
	Construct by taking reference of block from within the list and the specified index.
unsigned int	get () const
	Get value as unsigned, no range-checking.
bool	set (unsigned int val)
	Set value, returning true if changed, no range-checking.

Friends
class	bitSet

Additional Inherited Members
Protected Attributes inherited from PackedList< Width >::reference
block_type &	ref_
	Reference to the block.
unsigned	shift_
	The bit shift to access the given sub-portion.

Detailed Description

A reference supporting read/write access to an entry.

Definition at line 640 of file bitSet.H.

Constructor & Destructor Documentation

reference() [1/3]

reference ( bitSet * parent, const label index )

inlineprotected

Construct by taking reference of block from within the list and the specified index.

Definition at line 124 of file bitSetI.H.

References bitSet, PackedList< Width >::reference::PackedList, and reference().

Referenced by operator=(), reference(), reference(), and reference().

Here is the call graph for this function:

Here is the caller graph for this function:

reference() [2/3]

reference ( const reference & )

defaultnoexcept

Copy construct.

References reference().

Here is the call graph for this function:

reference() [3/3]

reference ( reference && )

defaultnoexcept

Move construct.

References flip(), Foam::noexcept, and reference().

Here is the call graph for this function:

Member Function Documentation

operator&()

void operator& ( )

protecteddelete

References bitSet.

Here is the call graph for this function:

flip()

void flip ( )

inline

Flip the bit at the position, no range-checking.

Definition at line 134 of file bitSetI.H.

References PackedList< 1 >::max_value, PackedList< Width >::reference::ref_, and PackedList< Width >::reference::shift_.

Referenced by bitSet::flip(), and reference().

Here is the caller graph for this function:

operator=() [1/2]

void operator= ( const reference & other )

inline

Value assignment.

Definition at line 141 of file bitSetI.H.

References reference(), and bitSet::set().

Here is the call graph for this function:

operator=() [2/2]

void operator= ( const unsigned int val )

inline

Value assignment.

Definition at line 151 of file bitSetI.H.

References bitSet::set().

Here is the call graph for this function:

operator unsigned int()

operator unsigned int ( ) const

inline

Conversion operator.

Definition at line 160 of file bitSetI.H.

References PackedList< 1 >::get().

Here is the call graph for this function:

Friends And Related Symbol Documentation

bitSet

friend class bitSet

friend

Definition at line 646 of file bitSet.H.

References bitSet.

Referenced by bitSet, operator&(), and reference().

---

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

• src/OpenFOAM/containers/Bits/bitSet/bitSet.H
• src/OpenFOAM/containers/Bits/bitSet/bitSetI.H