AtomicStopSignal Class Reference

#include <alpaqa/util/atomic-stop-signal.hpp>

Detailed Description

Definition at line 7 of file atomic-stop-signal.hpp.

Collaboration diagram for AtomicStopSignal:

Public Member Functions
	AtomicStopSignal ()=default
	AtomicStopSignal (const AtomicStopSignal &)
AtomicStopSignal &	operator= (const AtomicStopSignal &)=delete
	AtomicStopSignal (AtomicStopSignal &&) noexcept
AtomicStopSignal &	operator= (AtomicStopSignal &&) noexcept
void	stop ()
bool	stop_requested () const

Private Attributes
std::atomic< bool >	stop_flag {false}

Constructor & Destructor Documentation

AtomicStopSignal() [1/3]

AtomicStopSignal ( )

default

AtomicStopSignal() [2/3]

AtomicStopSignal ( const AtomicStopSignal &  )

inline

Definition at line 10 of file atomic-stop-signal.hpp.

AtomicStopSignal() [3/3]

AtomicStopSignal ( AtomicStopSignal &&  )

inlinenoexcept

Definition at line 12 of file atomic-stop-signal.hpp.

Member Function Documentation

operator=() [1/2]

AtomicStopSignal & operator= ( const AtomicStopSignal &  )

delete

operator=() [2/2]

AtomicStopSignal & operator= ( AtomicStopSignal &&  )

inlinenoexcept

Definition at line 13 of file atomic-stop-signal.hpp.

stop()

void stop ( )

inline

Definition at line 15 of file atomic-stop-signal.hpp.

Here is the caller graph for this function:

stop_requested()

bool stop_requested ( ) const

inline

Definition at line 16 of file atomic-stop-signal.hpp.

Here is the caller graph for this function:

Member Data Documentation

stop_flag

std::atomic<bool> stop_flag {false}

private

Definition at line 21 of file atomic-stop-signal.hpp.

---

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

• src/alpaqa/include/alpaqa/util/atomic-stop-signal.hpp