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
Classes | Namespaces | Macros | Typedefs | Functions
Exception.h File Reference
#include <exception>
#include <ostream>
#include <string>
#include <vector>
#include "lsst/base.h"
#include "boost/current_function.hpp"

Go to the source code of this file.

Classes

struct  lsst.pex::exceptions::Tracepoint
 One point in the Traceback vector held by Exception. More...
 
class  lsst.pex::exceptions::Exception
 Provides consistent interface for LSST exceptions. More...
 

Namespaces

namespace  lsst
 
namespace  lsst.pex
 
namespace  lsst::pex::exceptions
 

Macros

#define LSST_EXCEPT_HERE   __FILE__, __LINE__, BOOST_CURRENT_FUNCTION
 For internal use; gathers the file, line, and function for a tracepoint.
 
#define LSST_EXCEPT(type, ...)   type(LSST_EXCEPT_HERE, __VA_ARGS__)
 Create an exception with a given type.
 
#define LSST_EXCEPT_ADD(e, m)   e.addMessage(LSST_EXCEPT_HERE, m)
 Add the current location and a message to an existing exception before rethrowing it.
 
#define LSST_EARGS_TYPED   char const *ex_file, int ex_line, char const *ex_func, std::string const &ex_message
 The initial arguments required for new exception subclasses.
 
#define LSST_EARGS_UNTYPED   ex_file, ex_line, ex_func, ex_message
 The initial arguments to the base class constructor for new subclasses.
 
#define LSST_EXCEPTION_TYPE(t, b, c)
 Macro used to define new types of exceptions without additional data.
 

Typedefs

typedef std::vector< Tracepointlsst::pex::exceptions::Traceback
 

Functions

std::ostreamlsst::pex::exceptions::operator<< (std::ostream &stream, Exception const &e)
 Push the text representation of an exception onto a stream.
 

Macro Definition Documentation

◆ LSST_EARGS_TYPED

#define LSST_EARGS_TYPED   char const *ex_file, int ex_line, char const *ex_func, std::string const &ex_message

The initial arguments required for new exception subclasses.

Definition at line 57 of file Exception.h.

◆ LSST_EARGS_UNTYPED

#define LSST_EARGS_UNTYPED   ex_file, ex_line, ex_func, ex_message

The initial arguments to the base class constructor for new subclasses.

Definition at line 60 of file Exception.h.

◆ LSST_EXCEPT

#define LSST_EXCEPT ( type,
... )   type(LSST_EXCEPT_HERE, __VA_ARGS__)

Create an exception with a given type.

Parameters
[in]typeC++ type of the exception to be thrown.
[in]...The message, and optionally other arguments (dependent on the type).

Definition at line 48 of file Exception.h.

◆ LSST_EXCEPT_ADD

#define LSST_EXCEPT_ADD ( e,
m )   e.addMessage(LSST_EXCEPT_HERE, m)

Add the current location and a message to an existing exception before rethrowing it.

Definition at line 54 of file Exception.h.

◆ LSST_EXCEPT_HERE

#define LSST_EXCEPT_HERE   __FILE__, __LINE__, BOOST_CURRENT_FUNCTION

For internal use; gathers the file, line, and function for a tracepoint.

Definition at line 40 of file Exception.h.

◆ LSST_EXCEPTION_TYPE

#define LSST_EXCEPTION_TYPE ( t,
b,
c )
Value:
class LSST_EXPORT t : public b { \
public: \
t(std::string const& message) : b(message){}; \
virtual char const* getType(void) const noexcept { return #c " *"; }; \
virtual lsst::pex::exceptions::Exception* clone(void) const { return new t(*this); }; \
};
#define LSST_EARGS_UNTYPED
The initial arguments to the base class constructor for new subclasses.
Definition Exception.h:60
#define LSST_EARGS_TYPED
The initial arguments required for new exception subclasses.
Definition Exception.h:57
table::Key< int > b
#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

Macro used to define new types of exceptions without additional data.

Parameters
[in]tType of the exception.
[in]bBase class of the exception.
[in]cC++ class of the exception (fully specified).

Definition at line 69 of file Exception.h.

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 };