boost::mpi::exception Class Reference

Catch-all exception class for MPI errors. More...

#include <exception.hpp>

Inheritance diagram for boost::mpi::exception:

Collaboration diagram for boost::mpi::exception:

Public Member Functions
	exception (const char *routine, int result_code)
	Build a new exception exception. More...
virtual	~exception () throw ()
virtual const char *	what () const throw ()
	A description of the error that occurred. More...
const char *	routine () const
	Retrieve the name of the MPI routine that reported the error. More...
int	result_code () const
	Retrieve the result code returned from the MPI routine that reported the error. More...
int	error_class () const
	Returns the MPI error class associated with the error that triggered this exception. More...

Protected Attributes
const char *	routine_
	The MPI routine that triggered the error. More...
int	result_code_
	The failed result code reported by the MPI implementation. More...
std::string	message
	The formatted error message. More...

Detailed Description

Catch-all exception class for MPI errors.

Instances of this class will be thrown when an MPI error occurs. MPI failures that trigger these exceptions may or may not be recoverable, depending on the underlying MPI implementation. Consult the documentation for your MPI implementation to determine the effect of MPI errors.

Constructor & Destructor Documentation

boost::mpi::exception::exception	(	const char *	routine,
		int	result_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.
result_code	The result code returned from the MPI routine that aborted with an error.

virtual boost::mpi::exception::~exception ( ) throw ( )

virtual

Member Function Documentation

int boost::mpi::exception::error_class ( ) const

inline

Returns the MPI error class associated with the error that triggered this exception.

int boost::mpi::exception::result_code ( ) const

inline

Retrieve the result code returned from the MPI routine that reported the error.

const char* boost::mpi::exception::routine ( ) const

inline

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

virtual const char* boost::mpi::exception::what ( ) const throw ( )

inlinevirtual

A description of the error that occurred.

Member Data Documentation

std::string boost::mpi::exception::message

protected

The formatted error message.

int boost::mpi::exception::result_code_

protected

The failed result code reported by the MPI implementation.

const char* boost::mpi::exception::routine_

protected

The MPI routine that triggered the error.

---

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

• boost_1_57_0/boost/mpi/exception.hpp