Scope
Public Member Functions | Private Member Functions | Private Attributes | List of all members
StopCondition Class Reference
General helper function and classes

#include <helpers.h>

Public Member Functions

 StopCondition (const bool &_init=false)
 
bool IsSet () const
 
void Set (const bool &_a=true)
 

Private Member Functions

 StopCondition (StopCondition &ac)
 
StopCondition & operator= (StopCondition &ac)
 

Private Attributes

std::atomic_bool stop
 

Detailed Description

Thread-safe lock-free bool to signal a requested stop to the worker function currently executed in the Active's thread.

Definition at line 87 of file helpers.h.

Constructor & Destructor Documentation

StopCondition::StopCondition ( StopCondition &  ac)
private

disable copy

StopCondition::StopCondition ( const bool &  _init = false)
inline

Initialize as false.

Definition at line 102 of file helpers.h.

Member Function Documentation

StopCondition& StopCondition::operator= ( StopCondition &  ac)
private

disable assignment

bool StopCondition::IsSet ( ) const
inline
Returns
status of abort signal

Definition at line 105 of file helpers.h.

void StopCondition::Set ( const bool &  _a = true)
inline
Parameters
[in]_anew value of abort signal

Definition at line 108 of file helpers.h.

Member Data Documentation

std::atomic_bool StopCondition::stop
mutableprivate

the stop signal

Definition at line 91 of file helpers.h.

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