Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::mpi::packed_skeleton_iarchive Class Reference

An archiver that reconstructs a data structure based on the binary skeleton stored in a buffer. More...

#include <skeleton_and_content.hpp>

Inheritance diagram for boost::mpi::packed_skeleton_iarchive:
Collaboration diagram for boost::mpi::packed_skeleton_iarchive:

Public Member Functions

 packed_skeleton_iarchive (MPI_Comm const &comm, unsigned int flags=boost::archive::no_header)
 Construct a packed_skeleton_iarchive for the given communicator. More...
 
 packed_skeleton_iarchive (packed_iarchive &archive)
 Construct a packed_skeleton_iarchive that unpacks a skeleton from the given archive. More...
 
const packed_iarchiveget_skeleton () const
 Retrieve the archive corresponding to this skeleton. More...
 
packed_iarchiveget_skeleton ()
 Retrieve the archive corresponding to this skeleton. More...
 

Detailed Description

An archiver that reconstructs a data structure based on the binary skeleton stored in a buffer.

The packed_skeleton_iarchive class is an Archiver (as in the Boost.Serialization library) that can construct the the shape of a data structure based on a binary skeleton stored in a buffer. The packed_skeleton_iarchive is typically used by the receiver of a skeleton, to prepare a data structure that will eventually receive content separately.

Users will not generally need to use packed_skeleton_iarchive directly. Instead, use skeleton or get_skeleton.

Constructor & Destructor Documentation

boost::mpi::packed_skeleton_iarchive::packed_skeleton_iarchive ( MPI_Comm const &  comm,
unsigned int  flags = boost::archive::no_header 
)
inline

Construct a packed_skeleton_iarchive for the given communicator.

Parameters
commThe communicator over which this archive will be transmitted.
flagsControl the serialization of the skeleton. Refer to the Boost.Serialization documentation before changing the default flags.
boost::mpi::packed_skeleton_iarchive::packed_skeleton_iarchive ( packed_iarchive archive)
inlineexplicit

Construct a packed_skeleton_iarchive that unpacks a skeleton from the given archive.

Parameters
archivethe archive from which the skeleton will be unpacked.

Member Function Documentation

const packed_iarchive& boost::mpi::packed_skeleton_iarchive::get_skeleton ( ) const
inline

Retrieve the archive corresponding to this skeleton.

packed_iarchive& boost::mpi::packed_skeleton_iarchive::get_skeleton ( )
inline

Retrieve the archive corresponding to this skeleton.


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