Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::test::TestException Class Reference

#include <testutils/testexceptions.h>

+ Inheritance diagram for gmx::test::TestException:
+ Collaboration diagram for gmx::test::TestException:

Description

Exception class for reporting errors in tests.

This exception should be used for error conditions that are internal to the test, i.e., do not indicate errors in the tested code.

Public Member Functions

 TestException (const std::string &reason)
 Creates a test exception object with the provided detailed reason. More...
 
 TestException (const GromacsException &base)
 Creates a test exception based on another GromacsException object. More...
 
int errorCode () const override
 Returns the error code corresponding to the exception type.
 
- Public Member Functions inherited from gmx::GromacsException
const char * what () const noexceptoverride
 Returns the reason string for the exception. More...
 
template<class InfoType >
const InfoType::value_type * getInfo () const
 Returns the value associated with given ExceptionInfo. More...
 
template<class Tag , typename T >
void setInfo (const ExceptionInfo< Tag, T > &item)
 Associates extra information with the exception. More...
 
void prependContext (const std::string &context)
 Adds context information to this exception. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::GromacsException
 GromacsException (const ExceptionInitializer &details)
 Creates an exception object with the provided initializer/reason. More...
 

Constructor & Destructor Documentation

gmx::test::TestException::TestException ( const std::string &  reason)
inlineexplicit

Creates a test exception object with the provided detailed reason.

Parameters
[in]reasonDetailed reason for the exception.
gmx::test::TestException::TestException ( const GromacsException base)
inlineexplicit

Creates a test exception based on another GromacsException object.

Parameters
[in]baseException to wrap.
See Also
GMX_THROW_WRAPPER_TESTEXCEPTION

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