G4EventSynchronizationInterface Class Reference

#include <AtlasG4SyncEventUserInfo.h>

Collaboration diagram for G4EventSynchronizationInterface:

Public Types
enum class	EventOutcome { Success , Aborted , PreparationFailed , RunTerminated }

Public Member Functions
EventStatus	Status () const
void	Complete (EventOutcome outcome) noexcept
	Record the first completion outcome and wake Athena.
void	WaitStatusDone ()
EventOutcome	Outcome () const

Private Types
enum class	EventStatus { Ready , Done , Size }

Private Member Functions
void	WaitStatus (const EventStatus &)

Private Attributes
EventOutcome	m_outcome {EventOutcome::Success}
EventStatus	m_status {EventStatus::Ready}
std::mutex	m_mutex
std::condition_variable	m_cv

Detailed Description

Definition at line 27 of file AtlasG4SyncEventUserInfo.h.

Member Enumeration Documentation

EventOutcome

enum class G4EventSynchronizationInterface::EventOutcome

strong

Enumerator
Success
Aborted
PreparationFailed
RunTerminated

Definition at line 35 of file AtlasG4SyncEventUserInfo.h.

                            {
      Success,
      Aborted,
      PreparationFailed,
      RunTerminated
    };

EventStatus

enum class G4EventSynchronizationInterface::EventStatus

strongprivate

Enumerator
Ready
Done
Size

Definition at line 29 of file AtlasG4SyncEventUserInfo.h.

                         {
      Ready,
      Done,
      Size
    };

Member Function Documentation

Complete()

void G4EventSynchronizationInterface::Complete ( EventOutcome outcome )

noexcept

Record the first completion outcome and wake Athena.

Definition at line 40 of file AtlasG4SyncEventUserInfo.cxx.

{
  bool completed = false;
  {
    std::scoped_lock lk(m_mutex);
    if (m_status == EventStatus::Ready) {
      m_outcome = outcome;
      m_status = EventStatus::Done;
      completed = true;
    }
  }
  if (completed) {
    m_cv.notify_all();
  }
}

Outcome()

auto G4EventSynchronizationInterface::Outcome

(

)

const

Definition at line 34 of file AtlasG4SyncEventUserInfo.cxx.

{
  std::scoped_lock lk(m_mutex);
  return m_outcome;
}

Status()

auto G4EventSynchronizationInterface::Status

(

)

const

Definition at line 28 of file AtlasG4SyncEventUserInfo.cxx.

{
  std::scoped_lock lk(m_mutex);
  return m_status;
}

WaitStatus()

void G4EventSynchronizationInterface::WaitStatus ( const EventStatus & status )

private

Definition at line 56 of file AtlasG4SyncEventUserInfo.cxx.

{
  std::unique_lock lk(m_mutex);
  m_cv.wait(lk, [this,status]{ return m_status==status; });
}

WaitStatusDone()

void G4EventSynchronizationInterface::WaitStatusDone ( )

inline

Definition at line 45 of file AtlasG4SyncEventUserInfo.h.

{WaitStatus(EventStatus::Done);};

Member Data Documentation

m_cv

std::condition_variable G4EventSynchronizationInterface::m_cv

private

Definition at line 54 of file AtlasG4SyncEventUserInfo.h.

m_mutex

std::mutex G4EventSynchronizationInterface::m_mutex

mutableprivate

Definition at line 53 of file AtlasG4SyncEventUserInfo.h.

m_outcome

EventOutcome G4EventSynchronizationInterface::m_outcome {EventOutcome::Success}

private

Definition at line 51 of file AtlasG4SyncEventUserInfo.h.

{EventOutcome::Success};

m_status

EventStatus G4EventSynchronizationInterface::m_status {EventStatus::Ready}

private

Definition at line 52 of file AtlasG4SyncEventUserInfo.h.

{EventStatus::Ready};

---

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

• AtlasG4SyncEventUserInfo.h
• AtlasG4SyncEventUserInfo.cxx