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

#include <gromacs/utility/exceptions.h>

+ Inheritance diagram for gmx::RangeError:
+ Collaboration diagram for gmx::RangeError:

Description

Exception class for out-of-range values or indices.

Public Member Functions

 RangeError (const ExceptionInitializer &details)
 Creates an exception object with the provided initializer/reason. 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::RangeError::RangeError ( const ExceptionInitializer details)
inlineexplicit

Creates an exception object with the provided initializer/reason.

Parameters
[in]detailsInitializer for the exception.
Exceptions
std::bad_allocif out of memory.

It is possible to call this constructor either with an explicit ExceptionInitializer object (useful for more complex cases), or a simple string if only a reason string needs to be provided.


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