nest::BoolIndicatorUInt64 Class Reference

A wrapper class for an integer that is only allowed to take the values 0 and 1. More...

#include <per_thread_bool_indicator.h>

Public Member Functions
	BoolIndicatorUInt64 ()
	BoolIndicatorUInt64 (const bool status)
bool	is_true () const
bool	is_false () const

Protected Member Functions
void	set_true ()
void	set_false ()
void	logical_and (const bool status)

Private Attributes
std::uint_fast64_t	status_

Static Private Attributes
static constexpr std::uint_fast64_t	true_uint64 = true
static constexpr std::uint_fast64_t	false_uint64 = false

Friends
class	PerThreadBoolIndicator

Detailed Description

A wrapper class for an integer that is only allowed to take the values 0 and 1.

Used by PerThreadBoolIndicator to create a thread-safe vector indicating per-thread status. See issue #1394.

Constructor & Destructor Documentation

BoolIndicatorUInt64() [1/2]

nest::BoolIndicatorUInt64::BoolIndicatorUInt64

(

)

BoolIndicatorUInt64() [2/2]

nest::BoolIndicatorUInt64::BoolIndicatorUInt64

(

const bool

status

)

Member Function Documentation

is_false()

bool nest::BoolIndicatorUInt64::is_false ( ) const

inline

References false_uint64, and status_.

is_true()

bool nest::BoolIndicatorUInt64::is_true ( ) const

inline

References status_, and true_uint64.

logical_and()

void nest::BoolIndicatorUInt64::logical_and ( const bool  status )

inlineprotected

References status_.

set_false()

void nest::BoolIndicatorUInt64::set_false ( )

inlineprotected

References false_uint64, and status_.

set_true()

void nest::BoolIndicatorUInt64::set_true ( )

inlineprotected

References status_, and true_uint64.

Friends And Related Symbol Documentation

PerThreadBoolIndicator

friend class PerThreadBoolIndicator

friend

Member Data Documentation

false_uint64

constexpr std::uint_fast64_t nest::BoolIndicatorUInt64::false_uint64 = false

staticconstexprprivate

Referenced by is_false(), and set_false().

status_

std::uint_fast64_t nest::BoolIndicatorUInt64::status_

private

Referenced by is_false(), is_true(), logical_and(), set_false(), and set_true().

true_uint64

constexpr std::uint_fast64_t nest::BoolIndicatorUInt64::true_uint64 = true

staticconstexprprivate

Referenced by is_true(), and set_true().

---

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

• per_thread_bool_indicator.h
• per_thread_bool_indicator.cpp