Public Member Functions | Private Attributes | List of all members
actionlib::DestructionGuard::ScopedProtector Class Reference

Protects a DestructionGuard until this object goes out of scope. More...

#include <destruction_guard.h>

Public Member Functions

bool isProtected ()
 Checks if the ScopedProtector successfully protected the DestructionGuard. More...
 
 ScopedProtector (DestructionGuard &guard)
 Constructor for a ScopedProtector. More...
 
 ~ScopedProtector ()
 Releases protection of the DestructionGuard if necessary. More...
 

Private Attributes

DestructionGuardguard_
 
bool protected_
 

Detailed Description

Protects a DestructionGuard until this object goes out of scope.

Definition at line 93 of file destruction_guard.h.

Constructor & Destructor Documentation

actionlib::DestructionGuard::ScopedProtector::ScopedProtector ( DestructionGuard guard)
inline

Constructor for a ScopedProtector.

Parameters
guardThe DestructionGuard to protect

Definition at line 100 of file destruction_guard.h.

actionlib::DestructionGuard::ScopedProtector::~ScopedProtector ( )
inline

Releases protection of the DestructionGuard if necessary.

Definition at line 118 of file destruction_guard.h.

Member Function Documentation

bool actionlib::DestructionGuard::ScopedProtector::isProtected ( )
inline

Checks if the ScopedProtector successfully protected the DestructionGuard.

Returns
True if protection succeeded, false otherwise

Definition at line 110 of file destruction_guard.h.

Member Data Documentation

DestructionGuard& actionlib::DestructionGuard::ScopedProtector::guard_
private

Definition at line 126 of file destruction_guard.h.

bool actionlib::DestructionGuard::ScopedProtector::protected_
private

Definition at line 127 of file destruction_guard.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Wed Jun 5 2019 16:19:36