LSST Applications g0fba68d861+05a5e06e50,g1fd858c14a+904f1f4196,g2c84ff76c0+247cd845a2,g2c9e612ef2+f5117f1d55,g35bb328faa+fcb1d3bbc8,g4af146b050+123c2f4d45,g4d2262a081+a9e7a6e053,g4e0f332c67+c58e4b632d,g53246c7159+fcb1d3bbc8,g5a012ec0e7+ac98094cfc,g60b5630c4e+f5117f1d55,g67b6fd64d1+dd0349c22b,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g87b7deb4dc+2a1aa4536a,g8852436030+d21aad2af4,g89139ef638+dd0349c22b,g8d6b6b353c+f5117f1d55,g9125e01d80+fcb1d3bbc8,g989de1cb63+dd0349c22b,g9f33ca652e+0a580a37dd,g9f7030ddb1+ae84e0d5a5,ga2b97cdc51+f5117f1d55,gabe3b4be73+1e0a283bba,gb1101e3267+1d994e7598,gb58c049af0+f03b321e39,gb89ab40317+dd0349c22b,gcca6a94b71+4ed007ada1,gcf25f946ba+d21aad2af4,gd315a588df+9d9c5ccff1,gd6cbbdb0b4+75aa4b1db4,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+6fce216140,ge278dab8ac+c61fbefdff,ge410e46f29+dd0349c22b,ge82c20c137+e12a08b75a,gf67bdafdda+dd0349c22b,v28.0.2.rc1
LSST Data Management Base Package
Loading...
Searching...
No Matches
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, ...)
 Create an exception with a given type.
 
#define LSST_EXCEPT_ADD(e, 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,
... )
Value:
type(LSST_EXCEPT_HERE, __VA_ARGS__)
#define LSST_EXCEPT_HERE
For internal use; gathers the file, line, and function for a tracepoint.
Definition Exception.h:40

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 )
Value:
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
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition base.h:37

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