LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
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