VectorOutputArchive Class Reference

Wraps an archive around an STL vector for output. More...

#include <vector_archive.h>

Inheritance diagram for VectorOutputArchive:

Collaboration diagram for VectorOutputArchive:

Public Member Functions
	VectorOutputArchive (std::vector< unsigned char > &v, std::size_t hint=262144)
	Create a buffer to wrap the specified vector.
void	close ()
	Close the archive.
void	flush ()
	Flush the archive.
void	open (std::size_t hint=262144)
	Clear any data in the vector and ensure its capacity is at least hint.
template<class T>
std::enable_if< madness::is_trivially_serializable< T >::value, void >::type	store (const T *t, long n) const
	Appends data to the end of the vector.
Public Member Functions inherited from madness::archive::BaseArchive
	BaseArchive ()

Public Attributes
std::vector< unsigned char > *	v
	The STL vector being wrapped.

Additional Inherited Members
Public Types inherited from madness::archive::BaseOutputArchive
using	is_saving = std::true_type
	Type used by Boost.Serialization to determine if this object is an output archive.
Public Types inherited from madness::archive::BaseArchive
using	is_loading = std::false_type
	Type used by Boost.Serialization to determine if this object is an input archive.
using	is_saving = std::false_type
	Type used by Boost.Serialization to determine if this object is an output archive.
Static Public Attributes inherited from madness::archive::BaseOutputArchive
static constexpr bool	is_output_archive = true
	Flag to determine if this object is an output archive.
Static Public Attributes inherited from madness::archive::BaseArchive
static constexpr bool	is_archive = true
	Flag to determine if this object is an archive.
static constexpr bool	is_input_archive = false
	Flag to determine if this object is an input archive.
static constexpr bool	is_output_archive = false
	Flag to determine if this object is an output archive.
static constexpr bool	is_parallel_archive = false
	Flag to determine if this object is a parallel archive.

Detailed Description

Wraps an archive around an STL vector for output.

Constructor & Destructor Documentation

VectorOutputArchive()

madness::archive::VectorOutputArchive::VectorOutputArchive ( std::vector< unsigned char > & v, std::size_t hint = 262144 )

inline

Create a buffer to wrap the specified vector.

Parameters

[in]	v	The vector.
[in]	hint	The minimum capacity of the vector.

Member Function Documentation

close()

void madness::archive::VectorOutputArchive::close ( )

inline

Close the archive.

flush()

void madness::archive::VectorOutputArchive::flush ( )

inline

Flush the archive.

open()

void madness::archive::VectorOutputArchive::open ( std::size_t hint = 262144 )

inline

Clear any data in the vector and ensure its capacity is at least hint.

Parameters

[in]

hint

The minimum capacity for the vector.

store()

template<class T>

std::enable_if< madness::is_trivially_serializable< T >::value, void >::type madness::archive::VectorOutputArchive::store ( const T * t, long n ) const

inline

Appends data to the end of the vector.

Todo

Verify/complete the documentation.

Template Parameters

T	The type of data to be appended.

Parameters

[in]	t	Pointer to the data to be appended.
[in]	n	The number of data items to be appended.

Returns

Description needed.

Member Data Documentation

v

std::vector<unsigned char>* madness::archive::VectorOutputArchive::v

mutable

The STL vector being wrapped.

---

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

• vector_archive.h