OpenVDB 5.1.0

NullInterrupter.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2018 DreamWorks Animation LLC
4 //
5 // All rights reserved. This software is distributed under the
6 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
7 //
8 // Redistributions of source code must retain the above copyright
9 // and license notice and the following restrictions and disclaimer.
10 //
11 // * Neither the name of DreamWorks Animation nor the names of
12 // its contributors may be used to endorse or promote products derived
13 // from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
20 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (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 // IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
27 // LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
28 //
30 //
32
33 #ifndef OPENVDB_UTIL_NULL_INTERRUPTER_HAS_BEEN_INCLUDED
34 #define OPENVDB_UTIL_NULL_INTERRUPTER_HAS_BEEN_INCLUDED
35
36 #include <openvdb/version.h>
37
38 namespace openvdb {
39 OPENVDB_USE_VERSION_NAMESPACE
40 namespace OPENVDB_VERSION_NAME {
41 namespace util {
42
52 struct NullInterrupter
53 {
55 NullInterrupter () {}
58 void start(const char* name = NULL) { (void)name; }
60 void end() {}
67 inline bool wasInterrupted(int percent = -1) { (void)percent; return false; }
68 };
69
75 template <typename T>
76 inline bool wasInterrupted(T* i, int percent = -1) { return i && i->wasInterrupted(percent); }
77
79 template<>
80 inline bool wasInterrupted<util::NullInterrupter>(util::NullInterrupter*, int) { return false; }
81
82 } // namespace util
83 } // namespace OPENVDB_VERSION_NAME
84 } // namespace openvdb
85
86 #endif // OPENVDB_UTIL_NULL_INTERRUPTER_HAS_BEEN_INCLUDED
87
88 // Copyright (c) 2012-2018 DreamWorks Animation LLC
89 // All rights reserved. This software is distributed under the
90 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
openvdb::v5_1::util::NullInterrupter::start
void start(const char *name=NULL)
Definition: NullInterrupter.h:58
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:136
openvdb::v5_1::util::NullInterrupter::NullInterrupter
NullInterrupter()
Default constructor.
Definition: NullInterrupter.h:55
openvdb::v5_1::util::wasInterrupted
bool wasInterrupted(T *i, int percent=-1)
Definition: NullInterrupter.h:76
openvdb::v5_1::util::NullInterrupter::wasInterrupted
bool wasInterrupted(int percent=-1)
Definition: NullInterrupter.h:67
openvdb
Definition: Exceptions.h:40
version.h
Library and file format version numbers.
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:188
openvdb::v5_1::util::NullInterrupter::end
void end()
Signal the end of an interruptible operation.
Definition: NullInterrupter.h:60
openvdb::v5_1::util::NullInterrupter
Dummy NOOP interrupter class defining interface.
Definition: NullInterrupter.h:52