lsst.pex.exceptions  15.0-1-g14e9bfd+5
Public Member Functions | List of all members
lsst::pex::exceptions::Exception Class Reference

#include <Exception.h>

Inheritance diagram for lsst::pex::exceptions::Exception:
std::exception lsst::pex::exceptions::LogicError lsst::pex::exceptions::NotFoundError lsst::pex::exceptions::RuntimeError lsst::pex::exceptions::DomainError lsst::pex::exceptions::InvalidParameterError lsst::pex::exceptions::LengthError lsst::pex::exceptions::OutOfRangeError lsst::pex::exceptions::IoError lsst::pex::exceptions::OverflowError lsst::pex::exceptions::RangeError lsst::pex::exceptions::TypeError lsst::pex::exceptions::UnderflowError

Public Member Functions

 Exception (char const *file, int line, char const *func, std::string const &message)
 Standard constructor, intended for C++ use via the LSST_EXCEPT() macro. More...
 
 Exception (std::string const &message)
 Message-only constructor, intended for use from Python only. More...
 
virtual ~Exception (void) throw ()
 
void addMessage (char const *file, int line, char const *func, std::string const &message)
 Add a tracepoint and a message to an exception before rethrowing it (access via LSST_EXCEPT_ADD). More...
 
Traceback const & getTraceback (void) const throw ()
 Retrieve the list of tracepoints associated with an exception. More...
 
virtual std::ostreamaddToStream (std::ostream &stream) const
 Add a text representation of this exception, including its traceback with messages, to a stream. More...
 
virtual char const * what (void) const throw ()
 Return a character string summarizing this exception. More...
 
virtual char const * getType (void) const throw ()
 Return the fully-specified C++ type of a pointer to the exception. More...
 
virtual Exceptionclone (void) const
 Return a copy of the exception as an Exception*. More...
 
what (T... args)
 

Detailed Description

Definition at line 99 of file Exception.h.

Constructor & Destructor Documentation

◆ Exception() [1/2]

lsst::pex::exceptions::Exception::Exception ( char const *  file,
int  line,
char const *  func,
std::string const &  message 
)

Standard constructor, intended for C++ use via the LSST_EXCEPT() macro.

Parameters
[in]fileFilename (automatically passed in by macro).
[in]lineLine number (automatically passed in by macro).
[in]funcFunction name (automatically passed in by macro).
[in]messageInformational string attached to exception.

Definition at line 44 of file Exception.cc.

◆ Exception() [2/2]

lsst::pex::exceptions::Exception::Exception ( std::string const &  message)
explicit

Message-only constructor, intended for use from Python only.

While this constructor can be called from C++, it's better to use the LSST_EXCEPT macro there, which stores file/line/function information as well. In Python, however, that information is stored outside the exception, so we don't want to duplicate it, and hence this constructor is invoked instead.

Parameters
[in]messageInformational string attached to exception.

Definition at line 49 of file Exception.cc.

◆ ~Exception()

lsst::pex::exceptions::Exception::~Exception ( void  )
throw (
)
virtual

Definition at line 53 of file Exception.cc.

Member Function Documentation

◆ addMessage()

void lsst::pex::exceptions::Exception::addMessage ( char const *  file,
int  line,
char const *  func,
std::string const &  message 
)

Add a tracepoint and a message to an exception before rethrowing it (access via LSST_EXCEPT_ADD).

Parameters
[in]fileFilename (automatically passed in by macro).
[in]lineLine number (automatically passed in by macro).
[in]funcFunction name (automatically passed in by macro).
[in]messageAdditional message to associate with this rethrow.

Definition at line 55 of file Exception.cc.

◆ addToStream()

std::ostream & lsst::pex::exceptions::Exception::addToStream ( std::ostream stream) const
virtual

Add a text representation of this exception, including its traceback with messages, to a stream.

Parameters
[in]streamReference to an output stream.
Returns
Reference to the output stream after adding the text.

Definition at line 93 of file Exception.cc.

◆ clone()

Exception * lsst::pex::exceptions::Exception::clone ( void  ) const
virtual

Return a copy of the exception as an Exception*.

Can be overridden by derived classes that add data or methods.

Returns
Exception* pointing to a copy of the exception.

Definition at line 120 of file Exception.cc.

◆ getTraceback()

Traceback const & lsst::pex::exceptions::Exception::getTraceback ( void  ) const
throw (
)

Retrieve the list of tracepoints associated with an exception.

Definition at line 89 of file Exception.cc.

◆ getType()

char const * lsst::pex::exceptions::Exception::getType ( void  ) const
throw (
)
virtual

Return the fully-specified C++ type of a pointer to the exception.

This is overridden by derived classes (automatically if the LSST_EXCEPTION_TYPE macro is used). It is used by the Python interface.

Returns
String with the C++ type; does not need to be freed/deleted.

Definition at line 116 of file Exception.cc.

◆ what()

char const * lsst::pex::exceptions::Exception::what ( void  ) const
throw (
)
virtual

Return a character string summarizing this exception.

This combines all the messages added to the exception, but not the type or traceback (use the stream operator to get this more detailed information).

Not allowed to throw any exceptions.

Returns
String representation; does not need to be freed/deleted.

Definition at line 112 of file Exception.cc.


The documentation for this class was generated from the following files: