Argus Camera Sample Argus Camera Sample

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ScopedGuard.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of NVIDIA CORPORATION nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #ifndef SCOPED_GUARD_H
30 #define SCOPED_GUARD_H
31
32 namespace ArgusSamples
33 {
34
35 /**
36 * RAII-syle class performing an action when control flow leaves the scope. Typically the action
37 * to be performed is to undo a previous action in case of an error.
38 */
39 template <typename T> class ScopedGuard
40 {
41 public:
42 /**
43 * Action function type.
44 */
45 typedef bool (T::*ActionType)();
46
47 /**
48 * Constructor
49 *
50 * @param object [in] the object to perform the action on
51 * @param action [in] the action to perform
52 */
53 ScopedGuard(T *object, ActionType action)
54 : m_object(object)
55 , m_action(action)
56 {
57 }
58 /**
59 * Destructor
60 */
61 ~ScopedGuard()
62 {
63 leaveScope();
64 }
65
66 /**
67 * Cancel the action associated with this instance.
68 */
69 void cancel()
70 {
71 m_action = NULL;
72 }
73
74 private:
75 T *m_object;
76 ActionType m_action;
77
78 /**
79 * Called when leaving the scope. Calls action and resets the action.
80 */
81 void leaveScope()
82 {
83 if (m_action && m_object)
84 {
85 if (!(m_object->*m_action)())
86 REPORT_ERROR("Action call failed");
87 m_object = NULL;
88 m_action = NULL;
89 }
90 }
91
92 /**
93 * Hide default/copy constructor and assignment operator
94 */
95 ScopedGuard();
96 ScopedGuard(ScopedGuard &other);
97 const ScopedGuard& operator = (const ScopedGuard&);
98 };
99
100 } // namespace ArgusSamples
101
102 #endif // SCOPED_GUARD_H