LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst::meas::base::MeasurementError Class Reference

Exception to be thrown when a measurement algorithm experiences a known failure mode. More...

#include <exceptions.h>

Inheritance diagram for lsst::meas::base::MeasurementError:
lsst::pex::exceptions::RuntimeError lsst::pex::exceptions::Exception std::exception

Public Member Functions

 MeasurementError (std::string const &message, std::size_t flagBit)
 Constructor; should only be invoked from Python macro. More...
 
 MeasurementError (LSST_EARGS_TYPED, std::size_t flagBit)
 Constructor; should only be invoked by the LSST_EXCEPT macro (see class docs) More...
 
std::size_t getFlagBit () const
 Return the flag bit associated with the error. More...
 
virtual char const * getType (void) const throw ()
 Return the fully-specified C++ type of a pointer to the exception. More...
 
virtual lsst::pex::exceptions::Exceptionclone (void) const
 Return a copy of the exception as an Exception pointer. More...
 
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)
 

Detailed Description

Exception to be thrown when a measurement algorithm experiences a known failure mode.

In addition to the usual message, MeasurementError must be constructed with the bit of the algorithm-specific flag that indicates the known failure mode. This allows the measurement framework to set that flag upon failure. Typically, this flag bit is also used to look up the message from the algorithm classes FlagDefinition list; the common pattern is:

if (badThingHappened) {
// BAD_THING is an enum value from the Algorithm's FlagBits enum; getFlagDefinitions()
// is a static method algorithms are expected to define.
throw LSST_EXCEPT(MeasurementError, getFlagDefinitions()[BAD_THING), BAD_THING);
}

Definition at line 48 of file exceptions.h.

Constructor & Destructor Documentation

◆ MeasurementError() [1/2]

lsst::meas::base::MeasurementError::MeasurementError ( std::string const &  message,
std::size_t  flagBit 
)
inline

Constructor; should only be invoked from Python macro.

Definition at line 51 of file exceptions.h.

52  : pex::exceptions::RuntimeError(message), _flagBit(flagBit) {}

◆ MeasurementError() [2/2]

lsst::meas::base::MeasurementError::MeasurementError ( LSST_EARGS_TYPED  ,
std::size_t  flagBit 
)
inline

Constructor; should only be invoked by the LSST_EXCEPT macro (see class docs)

Definition at line 55 of file exceptions.h.

56  : pex::exceptions::RuntimeError(LSST_EARGS_UNTYPED), _flagBit(flagBit) {}

Member Function Documentation

◆ addMessage()

void 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.

49  {
50  std::ostringstream stream;
51  stream << _message;
52  if (_traceback.empty()) {
53  // This means the message-only constructor was used, which should only happen
54  // from Python...but this method isn't accessible from Python, so maybe
55  // this Exception was thrown in Python, then passed back to C++. Or, more
56  // likely, someone didn't read the warning and threw this exception in C++
57  // without using LSST_EXCEPT.
58  // But, because we don't have a traceback for that first message, we can't
59  // add one here without messing up the stringification logic later. Since
60  // this is a rare case (and should be considered a bug, but we don't want
61  // exception code throwing its own exceptions unless it absolutely has to),
62  // we'll proceed by just appending the message and ignoring the traceback.
63  stream << "; " << message;
64  } else {
65  if (_traceback.size() == static_cast<std::size_t>(1)) {
66  // The original message doesn't have an index (because it's faster,
67  // and there's no need if there's only one), so when we add the second,
68  // we have to give it an index.
69  stream << " {0}; ";
70  } else {
71  stream << "; ";
72  }
73  stream << message << " {" << _traceback.size() << "}";
74  _traceback.push_back(Tracepoint(file, line, func, message));
75  }
76  _message = stream.str();
77 }

◆ addToStream()

std::ostream & 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.

81  {
82  if (_traceback.empty()) {
83  // The exception was raised in Python, so we don't include the traceback, the type, or any
84  // newlines, because Python will print those itself.
85  stream << _message;
86  } else {
87  stream << std::endl; // Start with a newline to separate our stuff from Pythons "<type>: " prefix.
88  for (std::size_t i = 0; i != _traceback.size(); ++i) {
89  stream << " File \"" << _traceback[i]._file << "\", line " << _traceback[i]._line << ", in "
90  << _traceback[i]._func << std::endl;
91  stream << " " << _traceback[i]._message << " {" << i << "}" << std::endl;
92  }
94  stream << type << ": '" << _message << "'" << std::endl;
95  }
96  return stream;
97 }

◆ clone()

virtual lsst::pex::exceptions::Exception* lsst::meas::base::MeasurementError::clone ( void  ) const
inlinevirtual

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.

Reimplemented from lsst::pex::exceptions::Exception.

Definition at line 63 of file exceptions.h.

63 { return new MeasurementError(*this); };

◆ getFlagBit()

std::size_t lsst::meas::base::MeasurementError::getFlagBit ( ) const
inline

Return the flag bit associated with the error.

Definition at line 59 of file exceptions.h.

59 { return _flagBit; }

◆ getTraceback()

Traceback const & Exception::getTraceback ( void  ) const
noexceptinherited

Retrieve the list of tracepoints associated with an exception.

Definition at line 79 of file Exception.cc.

79 { return _traceback; }

◆ getType()

virtual char const* lsst::meas::base::MeasurementError::getType ( void  ) const
throw (
)
inlinevirtual

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.

Reimplemented from lsst::pex::exceptions::Exception.

Definition at line 61 of file exceptions.h.

61 { return "lsst::meas::base::MeasurementError *"; };

◆ what()

char const * 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.

99 { return _message.c_str(); }

The documentation for this class was generated from the following file:
std::strlen
T strlen(T... args)
std::string
STL class.
std::vector::size
T size(T... args)
std::vector::push_back
T push_back(T... args)
LSST_EARGS_UNTYPED
#define LSST_EARGS_UNTYPED
The initial arguments to the base class constructor for new subclasses.
Definition: Exception.h:60
std::string::c_str
T c_str(T... args)
lsst::afw.display.ds9.line
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:105
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostringstream
STL class.
lsst::pex::exceptions::Exception::getType
virtual char const * getType(void) const noexcept
Return the fully-specified C++ type of a pointer to the exception.
Definition: Exception.cc:101
std::endl
T endl(T... args)
type
table::Key< int > type
Definition: Detector.cc:163
lsst.display.ds9.ds9.file
file
Definition: ds9.py:39
lsst::meas::base::MeasurementError::MeasurementError
MeasurementError(std::string const &message, std::size_t flagBit)
Constructor; should only be invoked from Python macro.
Definition: exceptions.h:51
std::vector::empty
T empty(T... args)
std::ostringstream::str
T str(T... args)
std::size_t