Eclipse SUMO - Simulation of Urban MObility
FXConditionalLock Class Reference

A scoped lock which only triggers on condition. More...

#include <FXConditionalLock.h>

Collaboration diagram for FXConditionalLock:

Public Member Functions

 FXConditionalLock (FXMutex &m, const bool condition)
 Construct & lock associated mutex if the condition is true. More...
 
 ~FXConditionalLock ()
 Destroy and unlock associated mutex. More...
 

Private Member Functions

FXConditionalLockoperator= (const FXConditionalLock &)=delete
 

Private Attributes

const bool myCondition
 
FXMutex & myMutex
 

Detailed Description

A scoped lock which only triggers on condition.

Definition at line 37 of file FXConditionalLock.h.

Constructor & Destructor Documentation

◆ FXConditionalLock()

FXConditionalLock::FXConditionalLock ( FXMutex &  m,
const bool  condition 
)
inline

Construct & lock associated mutex if the condition is true.

Definition at line 40 of file FXConditionalLock.h.

◆ ~FXConditionalLock()

FXConditionalLock::~FXConditionalLock ( )
inline

Destroy and unlock associated mutex.

Definition at line 48 of file FXConditionalLock.h.

References myCondition, and myMutex.

Member Function Documentation

◆ operator=()

FXConditionalLock& FXConditionalLock::operator= ( const FXConditionalLock )
privatedelete

Field Documentation

◆ myCondition

const bool FXConditionalLock::myCondition
private

Definition at line 56 of file FXConditionalLock.h.

Referenced by ~FXConditionalLock().

◆ myMutex

FXMutex& FXConditionalLock::myMutex
private

Definition at line 55 of file FXConditionalLock.h.

Referenced by ~FXConditionalLock().


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