MutexGuard.h
Go to the documentation of this file.
1 /*=============================================================================
2  Copyright (C) 2012 Allied Vision Technologies. All Rights Reserved.
3 
4  Redistribution of this file, in original or modified form, without
5  prior written consent of Allied Vision Technologies is prohibited.
6 
7 -------------------------------------------------------------------------------
8 
9  File: MutexGuard.h
10 
11  Description: Definition of a mutex helper class for locking and unlocking.
12  Intended for use in the implementation of Vimba CPP API.
13 
14 -------------------------------------------------------------------------------
15 
16  THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
17  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
18  NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
24  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 
27 =============================================================================*/
28 
29 #ifndef AVT_VMBAPI_MUTEXGUARD
30 #define AVT_VMBAPI_MUTEXGUARD
31 
32 #include <VimbaCPP/Include/Mutex.h>
34 
35 namespace AVT
36 {
37 namespace VmbAPI
38 {
39 
41 {
42  public:
43  MutexGuard();
44  MutexGuard( MutexPtr &pMutex );
45  MutexGuard( BasicLockablePtr pLockable );
46  MutexGuard( const BasicLockable &rLockable );
47  ~MutexGuard();
48 
49  void Protect();
50  bool Release();
51 
52  protected:
54 };
55 
56 } //namespace VmbAPI
57 } //namespace AVT
58 
59 #endif //AVT_VMBAPI_MUTEXGUARD
AVT::VmbAPI::Mutex
Definition: Mutex.h:42
AVT
Definition: AncillaryData.h:35
AVT::VmbAPI::MutexGuard::m_pMutex
Mutex * m_pMutex
Definition: MutexGuard.h:53
AVT::VmbAPI::MutexGuard::Protect
void Protect()
Definition: MutexGuard.cpp:78
AVT::VmbAPI::MutexGuard::MutexGuard
MutexGuard()
Definition: MutexGuard.cpp:36
AVT::VmbAPI::BasicLockable
Definition: BasicLockable.h:38
Mutex.h
AVT::VmbAPI::MutexGuard::~MutexGuard
~MutexGuard()
Definition: MutexGuard.cpp:73
BasicLockable.h
AVT::VmbAPI::MutexGuard
Definition: MutexGuard.h:40
AVT::VmbAPI::MutexGuard::Release
bool Release()
Definition: MutexGuard.cpp:89


avt_vimba_camera
Author(s): Allied Vision Technologies, Miquel Massot
autogenerated on Sat Jun 3 2023 02:14:12