Teuchos::CommStatus< OrdinalType > Class Template Reference

Encapsulation of MPI_Status. More...

#include <Teuchos_Comm.hpp>

Inheritance diagram for Teuchos::CommStatus< OrdinalType >:

List of all members.

Public Member Functions
virtual	~CommStatus ()
	Destructor (declared virtual for memory safety)
virtual OrdinalType	getSourceRank ()=0
	The source rank that sent the message.

---

Detailed Description

template<class OrdinalType>
class Teuchos::CommStatus< OrdinalType >

Encapsulation of MPI_Status.

This interface encapsulates the result of a receive (the MPI_Status struct). Its main use is to figure out which process sent you a message, if you received it using MPI_ANY_SOURCE.

Template Parameters:

OrdinalType

The same template parameter as Comm. Only use int here. We only make this a template class for compatibility with Comm.

Note:

For now, this class only exposes the rank of the process that sent the message (the "source rank"). Later, we might expose other fields of MPI_Status in this interface. For now, you can attempt a dynamic cast to MpiCommStatus to access all three fields (MPI_SOURCE, MPI_TAG, and MPI_ERROR).

Definition at line 79 of file Teuchos_Comm.hpp.

---

Constructor & Destructor Documentation

template<class OrdinalType >

virtual Teuchos::CommStatus< OrdinalType >::~CommStatus

(

)

[inline, virtual]

Destructor (declared virtual for memory safety)

Definition at line 82 of file Teuchos_Comm.hpp.

---

Member Function Documentation

template<class OrdinalType >

virtual OrdinalType Teuchos::CommStatus< OrdinalType >::getSourceRank

(

)

[pure virtual]

The source rank that sent the message.

Implemented in Teuchos::MpiCommStatus< OrdinalType >, and Teuchos::SerialCommStatus< OrdinalType >.

---

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

• Teuchos_Comm.hpp