Some Doxygen comments.
[libsub.git] / src / exceptions.h
1 /*
2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <stdexcept>
21 #include <string>
22
23 namespace sub {
24
25 /** @class XMLError
26  *  @brief An error raised when reading an XML file.
27  */
28 class XMLError : public std::exception
29 {
30 public:
31         XMLError (std::string const & message) : _message (message) {}
32         ~XMLError () throw () {}
33
34         /** @return error message */
35         char const * what () const throw () {
36                 return _message.c_str ();
37         }
38
39 private:
40         /** error message */
41         std::string _message;
42 };
43
44 /** @class STLError
45  *  @brief An error raised when reading a binary STL file.
46  */
47 class STLError : public std::exception
48 {
49 public:
50         STLError (std::string const & message) : _message (message) {}
51         ~STLError () throw () {}
52
53         /** @return error message */
54         char const * what () const throw () {
55                 return _message.c_str ();
56         }
57
58 private:
59         /** error message */
60         std::string _message;
61 };
62
63 }