LSST Applications g1653933729+a8ce1bb630,g171997e3ee+76e92115be,g1a997c3884+a8ce1bb630,g28da252d5a+4013ff5194,g2bbee38e9b+d6d0f9f6ae,g2bc492864f+d6d0f9f6ae,g2cdde0e794+ccb74358b7,g3156d2b45e+07302053f8,g347aa1857d+d6d0f9f6ae,g35bb328faa+a8ce1bb630,g3a166c0a6a+d6d0f9f6ae,g3e281a1b8c+130fae20e3,g4005a62e65+17cd334064,g414038480c+c9f68e2a12,g41af890bb2+3e1f62f438,g4e1a3235cc+9db7d56ad0,g7b55021d1b+7b623691d5,g80478fca09+334cc8d2bd,g82479be7b0+b568f6b267,g858d7b2824+37b39d8760,g9125e01d80+a8ce1bb630,ga5288a1d22+11cb34fefe,gae0086650b+a8ce1bb630,gb4ec7eb0ab+37b39d8760,gb58c049af0+d64f4d3760,gc081298178+284e133171,gc28159a63d+d6d0f9f6ae,gcf0d15dbbd+00fe2e0b07,gd6b7c0dfd1+8b62435e69,gda3e153d99+37b39d8760,gda6a2b7d83+00fe2e0b07,gdaeeff99f8+1711a396fd,gdd5a9049c5+23f3b3239a,ge2409df99d+5d9f551a54,ge33fd446bb+37b39d8760,ge79ae78c31+d6d0f9f6ae,gf0baf85859+2dea8344a2,gf5289d68f6+3777f3df5e,w.2024.41
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