LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Exception.h
Go to the documentation of this file.
1/*
2 * This file is part of pex_exceptions.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#ifndef LSST_PEX_EXCEPTIONS_EXCEPTION_H
25#define LSST_PEX_EXCEPTIONS_EXCEPTION_H
26
27#include <exception>
28#include <ostream>
29#include <string>
30#include <vector>
31
32#include "lsst/base.h"
33#include "boost/current_function.hpp"
34
35namespace lsst {
36namespace pex {
37namespace exceptions {
38
40#define LSST_EXCEPT_HERE __FILE__, __LINE__, BOOST_CURRENT_FUNCTION
41
48#define LSST_EXCEPT(type, ...) type(LSST_EXCEPT_HERE, __VA_ARGS__)
49
54#define LSST_EXCEPT_ADD(e, m) e.addMessage(LSST_EXCEPT_HERE, m)
55
57#define LSST_EARGS_TYPED char const *ex_file, int ex_line, char const *ex_func, std::string const &ex_message
58
60#define LSST_EARGS_UNTYPED ex_file, ex_line, ex_func, ex_message
61
69#define LSST_EXCEPTION_TYPE(t, b, c) \
70 class LSST_EXPORT t : public b { \
71 public: \
72 t(LSST_EARGS_TYPED) : b(LSST_EARGS_UNTYPED){}; \
73 t(std::string const& message) : b(message){}; \
74 virtual char const* getType(void) const noexcept { return #c " *"; }; \
75 virtual lsst::pex::exceptions::Exception* clone(void) const { return new t(*this); }; \
76 };
77
79struct Tracepoint {
88 Tracepoint(char const* file, int line, char const* func, std::string const& message);
89
90 char const* _file; // Compiled strings only; does not need deletion
91 int _line;
92 char const* _func; // Compiled strings only; does not need deletion
94};
96
108public:
117 Exception(char const* file, int line, char const* func,
118 std::string const& message); // Should use LSST_EARGS_TYPED, but that confuses doxygen.
119
130 explicit Exception(std::string const& message);
131
132 virtual ~Exception(void) noexcept;
133
142 void addMessage(char const* file, int line, char const* func, std::string const& message);
143
145 Traceback const& getTraceback(void) const noexcept;
146
154 virtual std::ostream& addToStream(std::ostream& stream) const;
155
166 virtual char const* what(void) const noexcept;
167
175 virtual char const* getType(void) const noexcept;
176
183 virtual Exception* clone(void) const;
184
185private:
186 std::string _message;
187 Traceback _traceback;
188};
189
198}
199} // namespace pex
200} // namespace lsst
201
202#endif
Basic LSST definitions.
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition base.h:37
Provides consistent interface for LSST exceptions.
Definition Exception.h:107
std::ostream & operator<<(std::ostream &stream, Exception const &e)
Push the text representation of an exception onto a stream.
Definition Exception.cc:105
std::vector< Tracepoint > Traceback
Definition Exception.h:95
One point in the Traceback vector held by Exception.
Definition Exception.h:79
Tracepoint(char const *file, int line, char const *func, std::string const &message)
Standard constructor, intended for C++ use.
Definition Exception.cc:39