Class Exception

Inheritance Relationships

Base Type

  • public exception

Class Documentation

class qhipster::mpi::Exception : public exception

Catch-all exception class for MPI errors.

Similar to the MPI exception class in the Boost libraries. Instances of this class will be thrown when an MPI error occurs.

Public Functions

Exception(const char *routine, int error_code)

Build a new Exception exception.

Parameters

  • routine: The MPI routine in which the error occurred. This should be a pointer to a string constant: it will not be copied.

  • error_code: The result code returned from the MPI routine that aborted with an error.

~Exception()
const char *what() const

A description of the error that occurred.

const char *routine() const

Retrieve the name of the MPI routine that reported the error.

int error_code() const

Obtain the result code returned from the MPI routine that caused an error.