Regina 7.4 Calculation Engine
regina::ImpossibleScenario Class Reference

An exception thrown when an unexpected scenario arises that should never be possible. More...

#include <utilities/exception.h>

Inheritance diagram for regina::ImpossibleScenario:
regina::ReginaException

Public Member Functions

 ImpossibleScenario (const std::string &msg)
 
 ImpossibleScenario (const char *msg)
 
 ImpossibleScenario (const ImpossibleScenario &) noexcept=default
 
ImpossibleScenariooperator= (const ImpossibleScenario &) noexcept=default
 

Detailed Description

An exception thrown when an unexpected scenario arises that should never be possible.

By "unexpected", we do not mean (for example) that a precondition was violated, or an invalid argument was passed to some function. Instead, we mean that within the implementation of some function, a situation arises that should be provably impossible. Seeing this exception would most likely indicate a bug in Regina's own source code (as opposed to an error by the user, or an incorrect use of Regina's API).

Such exceptions will typically not be mentioned in the API documentation (since, by their nature, they should never be thrown).

All member functions follow the same pattern as the parent class ReginaException, and are not documented again here.


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