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. More...
#define	LSST_EXCEPT(type, ...)   type(LSST_EXCEPT_HERE, __VA_ARGS__)
	Create an exception with a given type. More...
#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. More...
#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. More...
#define	LSST_EARGS_UNTYPED   ex_file, ex_line, ex_func, ex_message
	The initial arguments to the base class constructor for new subclasses. More...
#define	LSST_EXCEPTION_TYPE(t, b, c)
	Macro used to define new types of exceptions without additional data. More...

Typedefs
typedef std::vector< Tracepoint >	lsst::pex::exceptions::Traceback

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

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]	type	C++ 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(LSST_EARGS_TYPED) : b(LSST_EARGS_UNTYPED){};                                        \
        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); }; \
    };

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

Parameters

[in]	t	Type of the exception.
[in]	b	Base class of the exception.
[in]	c	C++ class of the exception (fully specified).

Definition at line 69 of file Exception.h.