Teuchos::MpiCommStatus< OrdinalType > Class Template Reference

MPI-specific implementation of CommStatus. More...

#include <Teuchos_DefaultMpiComm.hpp>

Inheritance diagram for Teuchos::MpiCommStatus< OrdinalType >:

List of all members.

Public Member Functions
	MpiCommStatus (MPI_Status status)
virtual	~MpiCommStatus ()
	Destructor (declared virtual for memory safety)
OrdinalType	getSourceRank ()
	The source rank that sent the message.
OrdinalType	getTag ()
	The tag of the received message.
OrdinalType	getError ()
	The error code of the received message.
Private Member Functions
	MpiCommStatus ()
	We forbid default construction syntactically.
Private Attributes
MPI_Status	status_
	The raw MPI_Status struct that this class encapsulates.

---

Detailed Description

template<class OrdinalType>
class Teuchos::MpiCommStatus< OrdinalType >

MPI-specific implementation of CommStatus.

Users would not normally create an instance of this class. The only time they might wish to do so is to encapsulate an MPI_Status returned by an external library or by their own code, and pass it into one of our functions like wait() or waitAll().

Template Parameters:

OrdinalType

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

Definition at line 131 of file Teuchos_DefaultMpiComm.hpp.

---

Constructor & Destructor Documentation

template<class OrdinalType >

Teuchos::MpiCommStatus< OrdinalType >::MpiCommStatus

(

MPI_Status

status

)

[inline]

Definition at line 133 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >

virtual Teuchos::MpiCommStatus< OrdinalType >::~MpiCommStatus

(

)

[inline, virtual]

Destructor (declared virtual for memory safety)

Definition at line 136 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >

Teuchos::MpiCommStatus< OrdinalType >::MpiCommStatus

(

)

[private]

We forbid default construction syntactically.

---

Member Function Documentation

template<class OrdinalType >

OrdinalType Teuchos::MpiCommStatus< OrdinalType >::getSourceRank

(

)

[inline, virtual]

The source rank that sent the message.

Implements Teuchos::CommStatus< OrdinalType >.

Definition at line 139 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >

OrdinalType Teuchos::MpiCommStatus< OrdinalType >::getTag

(

)

[inline, virtual]

The tag of the received message.

Implements Teuchos::CommStatus< OrdinalType >.

Definition at line 142 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >

OrdinalType Teuchos::MpiCommStatus< OrdinalType >::getError

(

)

[inline]

The error code of the received message.

Definition at line 145 of file Teuchos_DefaultMpiComm.hpp.

---

Member Data Documentation

template<class OrdinalType >

MPI_Status Teuchos::MpiCommStatus< OrdinalType >::status_ [private]

The raw MPI_Status struct that this class encapsulates.

Definition at line 152 of file Teuchos_DefaultMpiComm.hpp.

---

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

• Teuchos_DefaultMpiComm.hpp