CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes
edm::FinalWaitingTask Class Reference

#include <WaitingTask.h>

Inheritance diagram for edm::FinalWaitingTask:
edm::WaitingTask edm::TaskBase

Public Member Functions

bool done () const
 
void execute () final
 
 FinalWaitingTask ()
 
- Public Member Functions inherited from edm::WaitingTask
std::exception_ptr const * exceptionPtr () const
 Returns exception thrown by dependent task. More...
 
 WaitingTask ()
 Constructor. More...
 
 ~WaitingTask () override
 
- Public Member Functions inherited from edm::TaskBase
unsigned int decrement_ref_count ()
 
void increment_ref_count ()
 
 TaskBase ()
 Constructor. More...
 
virtual ~TaskBase ()=default
 

Private Member Functions

void recycle () final
 

Private Attributes

std::atomic< bool > m_done
 

Detailed Description

Use this class on the stack to signal the final task to be run. Call done() to check to see if the task was run and check value of exceptionPtr() to see if an exception was thrown by any task in the group.

Definition at line 76 of file WaitingTask.h.

Constructor & Destructor Documentation

◆ FinalWaitingTask()

edm::FinalWaitingTask::FinalWaitingTask ( )
inline

Definition at line 78 of file WaitingTask.h.

78 : m_done{false} {}

Member Function Documentation

◆ done()

bool edm::FinalWaitingTask::done ( ) const
inline

◆ execute()

void edm::FinalWaitingTask::execute ( void  )
inlinefinalvirtual

Implements edm::TaskBase.

Definition at line 80 of file WaitingTask.h.

80 { m_done = true; }

References m_done.

◆ recycle()

void edm::FinalWaitingTask::recycle ( )
inlinefinalprivatevirtual

Reimplemented from edm::TaskBase.

Definition at line 85 of file WaitingTask.h.

85 {}

Member Data Documentation

◆ m_done

std::atomic<bool> edm::FinalWaitingTask::m_done
private

Definition at line 86 of file WaitingTask.h.

Referenced by done(), and execute().

edm::FinalWaitingTask::m_done
std::atomic< bool > m_done
Definition: WaitingTask.h:86