lsst.pex.exceptions  21.0.0-2-gde069b7+f69268ea3b
Public Member Functions | List of all members
lsst::pex::exceptions::RangeError Class Reference

Reports when the result of an operation cannot be represented by the destination type. More...

#include <Runtime.h>

Inheritance diagram for lsst::pex::exceptions::RangeError:
lsst::pex::exceptions::RuntimeError lsst::pex::exceptions::Exception std::exception

Public Member Functions

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 noexcept
 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 noexcept
 Return a character string summarizing this exception. More...
 
what (T... args)
 
virtual char const * getType (void) const noexcept
 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 pointer. More...
 

Detailed Description

Reports when the result of an operation cannot be represented by the destination type.

Situations covered by this exception include lossy type conversions.

See also
OverflowError
UnderflowError
std::range_error

Definition at line 115 of file Runtime.h.

Member Function Documentation

◆ addMessage()

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

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 49 of file Exception.cc.

◆ addToStream()

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

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 81 of file Exception.cc.

◆ clone()

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

Return a copy of the exception as an Exception pointer.

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

Returns
Pointer to a copy of the exception.

Definition at line 103 of file Exception.cc.

◆ getTraceback()

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

Retrieve the list of tracepoints associated with an exception.

Definition at line 79 of file Exception.cc.

◆ getType()

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

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 101 of file Exception.cc.

◆ what()

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

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 99 of file Exception.cc.


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