Regina 7.3 Calculation Engine
Public Member Functions | List of all members
regina::SnapPeaIsNull Class Reference

An exception thrown when the SnapPea kernel is asked to work with a null SnapPea triangulation. More...

#include <utilities/exception.h>

Inheritance diagram for regina::SnapPeaIsNull:
regina::ReginaException

Public Member Functions

 SnapPeaIsNull (const char *fromFunction)
 Creates a new exception, and marks it as having occurred within the given Regina function. More...
 
 SnapPeaIsNull (const SnapPeaIsNull &) noexcept=default
 Creates a new copy of the given exception. More...
 
SnapPeaIsNulloperator= (const SnapPeaIsNull &) noexcept=default
 Sets this to be a copy of the given exception. More...
 

Detailed Description

An exception thrown when the SnapPea kernel is asked to work with a null SnapPea triangulation.

This is a "regular" exception type derived from ReginaException, and is typically thrown in scenarios where the user asks Regina to call some SnapPea kernel function but Regina has no native SnapPea triangulation to call it with. This is contrast to SnapPeaFatalError and SnapPeaMemoryFull, which are more severe errors that occur within the SnapPea kernel when it aborts processing unexpectedly, and which are not part of the regular ReginaException class hierarchy.

Note that the constructor for this exception class follows a different pattern from most of Regina's exception classes.

Constructor & Destructor Documentation

◆ SnapPeaIsNull() [1/2]

regina::SnapPeaIsNull::SnapPeaIsNull ( const char *  fromFunction)
inline

Creates a new exception, and marks it as having occurred within the given Regina function.

Parameters
fromFunctionthe name of the Regina function that the user called (in particular, this is not the name of the SnapPea kernel function that would have been called as a result). An example might be "SnapPeaTriangulation::homologyFilled".

◆ SnapPeaIsNull() [2/2]

regina::SnapPeaIsNull::SnapPeaIsNull ( const SnapPeaIsNull )
defaultnoexcept

Creates a new copy of the given exception.

Member Function Documentation

◆ operator=()

SnapPeaIsNull & regina::SnapPeaIsNull::operator= ( const SnapPeaIsNull )
defaultnoexcept

Sets this to be a copy of the given exception.

Returns
a reference to this exception.

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

Copyright © 1999-2023, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).