boost::mpi::content Class Reference

A proxy object that transfers the content of an object without its structure. More...

#include <skeleton_and_content.hpp>

Inheritance diagram for boost::mpi::content:

Public Member Functions
	content ()
	Constructs an empty content object. More...
	content (MPI_Datatype d, bool committed=true)
	This routine initializes the content object with an MPI data type that refers to the content of an object without its structure. More...
const content &	operator= (MPI_Datatype d)
	Replace the MPI data type referencing the content of an object. More...
MPI_Datatype	get_mpi_datatype () const
	Retrieve the MPI data type that refers to the content of the object. More...
void	commit ()
	Commit the MPI data type referring to the content of the object. More...

Detailed Description

A proxy object that transfers the content of an object without its structure.

The content class indicates that Boost.MPI should transmit or receive the content of an object, but without any information about the structure of the object. It is only meaningful to transmit the content of an object after the receiver has already received the skeleton for the same object.

Most users will not use content objects directly. Rather, they will invoke send, recv, or broadcast operations using get_content().

Constructor & Destructor Documentation

boost::mpi::content::content ( )

inline

Constructs an empty content object.

This object will not be useful for any Boost.MPI operations until it is reassigned.

boost::mpi::content::content ( MPI_Datatype  d, bool  committed = true  )

inline

This routine initializes the content object with an MPI data type that refers to the content of an object without its structure.

Parameters

d	the MPI data type referring to the content of the object.
committed	true indicates that MPI_Type_commit has already been excuted for the data type d.

Member Function Documentation

void boost::mpi::content::commit ( )

inline

Commit the MPI data type referring to the content of the object.

MPI_Datatype boost::mpi::content::get_mpi_datatype ( ) const

inline

Retrieve the MPI data type that refers to the content of the object.

Returns

the MPI data type, which should only be transmitted or received using MPI_BOTTOM as the address.

const content& boost::mpi::content::operator= ( MPI_Datatype  d )

inline

Replace the MPI data type referencing the content of an object.

Parameters

d	the new MPI data type referring to the content of the object.

Returns

*this

---

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

• boost_1_57_0/boost/mpi/skeleton_and_content.hpp