ome-files 0.2.2

Sentry.h
1 /*
2 * #%L
3 * OME-FILES C++ library for image IO.
4 * Copyright © 2006 - 2015 Open Microscopy Environment:
5 * - Massachusetts Institute of Technology
6 * - National Institutes of Health
7 * - University of Dundee
8 * - Board of Regents of the University of Wisconsin-Madison
9 * - Glencoe Software, Inc.
10 * %%
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * The views and conclusions contained in the software and documentation are
33 * those of the authors and should not be interpreted as representing official
34 * policies, either expressed or implied, of any organization.
35 * #L%
36 */
37
38 #ifndef OME_FILES_TIFF_SENTRY_H
39 #define OME_FILES_TIFF_SENTRY_H
40
41 #include <cstdarg>
42 #include <string>
43
44 #include <boost/thread.hpp>
45
46 #include <ome/compat/cstdint.h>
47 #include <ome/compat/memory.h>
48
49 namespace ome
50 {
51 namespace files
52 {
53 namespace tiff
54 {
55
73 class Sentry
74 {
75 public:
77 Sentry();
78
80 ~Sentry();
81
82 private:
90 void
91 setMessage(std::string const& message);
92
93 public:
101 std::string const&
102 getMessage() const;
103
115 void
116 error(const std::string& message) const;
117
125 void
126 error() const;
127
128 private:
130 static boost::recursive_mutex tiff_mutex;
131
133 boost::lock_guard<boost::recursive_mutex> lock;
134
136 std::string message;
137
149 static void
150 errorHandler(const char *module,
151 const char *fmt,
152 va_list ap);
153
154 };
155
156 }
157 }
158 }
159
160 #endif // OME_FILES_TIFF_SENTRY_H
161
162 /*
163 * Local Variables:
164 * mode:C++
165 * End:
166 */
ome::files::tiff::Sentry
Sentry for saving and restoring libtiff state.
Definition: Sentry.h:73
ome::files::tiff::Sentry::error
void error() const
Throw an Exception.
Definition: Sentry.cpp:186
ome::files::tiff::Sentry::lock
boost::lock_guard< boost::recursive_mutex > lock
Acquired lock on tiff_lock.
Definition: Sentry.h:133
ome::files::tiff::Sentry::~Sentry
~Sentry()
Destructor.
Definition: Sentry.cpp:159
ome::files::tiff::Sentry::getMessage
std::string const & getMessage() const
Get the latest error message.
Definition: Sentry.cpp:171
ome
Open Microscopy Environment C++.
ome::files::tiff::Sentry::errorHandler
static void errorHandler(const char *module, const char *fmt, va_list ap)
libtiff error handler.
Definition: Sentry.cpp:103
memory.h
ome::files::tiff::Sentry::setMessage
void setMessage(std::string const &message)
Set the latest error message.
Definition: Sentry.cpp:165
cstdint.h
ome::files::tiff::Sentry::tiff_mutex
static boost::recursive_mutex tiff_mutex
Mutex to lock libtiff access.
Definition: Sentry.h:130
ome::files::tiff::Sentry::Sentry
Sentry()
Constructor.
Definition: Sentry.cpp:152
ome::files::tiff::Sentry::message
std::string message
Last error message.
Definition: Sentry.h:136