nrfcxx::event_set_copy Class Reference

A helper class for processing snapshot nrfcxx::event_set values. More...

#include <nrfcxx/core.hpp>

Public Types
using	event_type = event_set::event_type
	The type used to represent a (set of) event(s). More...

Public Member Functions
	event_set_copy (event_set &events)
	Capture events and reset the original set.
	event_set_copy ()=default
	Create an empty event set.
	operator bool () const
	Implicit cast to bool, true if there are events pending.
bool	empty () const
	Return true iff no events remain.
event_type	events () const
	Return the bitmask of remaining events.
void	set (event_type events)
	Add a new event to the set.
bool	test_and_clear (event_type evt)
	Return true iff evt was set. More...

Detailed Description

A helper class for processing snapshot nrfcxx::event_set values.

Generally obtained through event_set::copy_and_clear(), and used to test for individual events without incurring mutex overhead.

Member Typedef Documentation

event_type

using nrfcxx::event_set_copy::event_type = event_set::event_type

The type used to represent a (set of) event(s).

Each event is an independent bit in the word representation.

Member Function Documentation

test_and_clear()

bool nrfcxx::event_set_copy::test_and_clear ( event_type  evt )

inline

Return true iff evt was set.

evt is cleared from the remaining events.

---

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

• nrfcxx/core.hpp