HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_AttributeMap::ScopedTryLock Class Reference

#include <PDG_AttributeMap.h>

Public Member Functions

 ScopedTryLock (const PDG_AttributeMap &attribute_map)
 
 ~ScopedTryLock ()
 
bool didLock () const
 

Detailed Description

Version of the above lock that only tries to lock, and sets a flag to true or false based on whether the lock was acquired. This should be used for UI updates that don't require access to a specific attrib and are simply presenting current state, for example. It reduces the amount of time the UI spends blocked on PDG structures.

Definition at line 279 of file PDG_AttributeMap.h.

Constructor & Destructor Documentation

PDG_AttributeMap::ScopedTryLock::ScopedTryLock ( const PDG_AttributeMap attribute_map)
inline

Definition at line 282 of file PDG_AttributeMap.h.

PDG_AttributeMap::ScopedTryLock::~ScopedTryLock ( )
inline

Definition at line 296 of file PDG_AttributeMap.h.

Member Function Documentation

bool PDG_AttributeMap::ScopedTryLock::didLock ( ) const
inline

Returns true only if the lock was successful. This method should be checked before performing any actions on this attribute map.

Definition at line 307 of file PDG_AttributeMap.h.


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