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_oarchive Class Reference

An archiver that records the binary skeleton of a data structure into a buffer. More...

#include <skeleton_and_content.hpp>

Inheritance diagram for boost::mpi::packed_skeleton_oarchive:
Collaboration diagram for boost::mpi::packed_skeleton_oarchive:

Public Member Functions

 packed_skeleton_oarchive (MPI_Comm const &comm, unsigned int flags=boost::archive::no_header)
 Construct a packed_skeleton_oarchive for the given communicator. More...
 
 packed_skeleton_oarchive (packed_oarchive &archive)
 Construct a packed_skeleton_oarchive that packs a skeleton into the given archive. More...
 
const packed_oarchiveget_skeleton () const
 Retrieve the archive corresponding to this skeleton. More...
 

Detailed Description

An archiver that records the binary skeleton of a data structure into a buffer.

The packed_skeleton_oarchive class is an Archiver (as in the Boost.Serialization library) that can record the shape of a data structure (called the "skeleton") into a binary representation stored in a buffer. The packed_skeleton_oarchive is typically used by the send of a skeleton, to pack the skeleton of a data structure for transmission separately from the content.

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

Constructor & Destructor Documentation

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

Construct a packed_skeleton_oarchive 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_oarchive::packed_skeleton_oarchive ( packed_oarchive archive)
inlineexplicit

Construct a packed_skeleton_oarchive that packs a skeleton into the given archive.

Parameters
archivethe archive to which the skeleton will be packed.

Member Function Documentation

const packed_oarchive& boost::mpi::packed_skeleton_oarchive::get_skeleton ( ) const
inline

Retrieve the archive corresponding to this skeleton.


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