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

An exception thrown when a function detects that its preconditions have been violated. More...

#include <utilities/exception.h>

Inheritance diagram for regina::FailedPrecondition:
regina::ReginaException

Public Member Functions

 FailedPrecondition (const std::string &msg)
 
 FailedPrecondition (const char *msg)
 
 FailedPrecondition (const FailedPrecondition &) noexcept=default
 
FailedPreconditionoperator= (const FailedPrecondition &) noexcept=default
 

Detailed Description

An exception thrown when a function detects that its preconditions have been violated.

The line between failed preconditions and invalid input arguments is not always clear, and so the roles of FailedPrecondition versus InvalidArgument are not clear-cut. Where relevant, each routine will document clearly which exception type it uses.

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:

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