LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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 };