Save archive for packed heterogeneous binary data. More...

#include <MemoryOArchive.h>

Public Member Functions
	MemoryOArchive ()
	Constructor.

virtual	~MemoryOArchive ()
	Destructor.

virtual void	allocate (size_t capacity)
	Allocate memory.

void	clear ()
	Resets the cursor to the beginning.

template<typename T >
MemoryOArchive &	operator<< (T &data)
	Save (write) one object to this archive via the << operator.

template<typename T >
MemoryOArchive &	operator& (T &data)
	Save (write) one object to this archive via the & operator.

template<typename T , size_t N>
MemoryOArchive &	operator<< (T(&data)[N])
	Save a fixed size array via operator <<.

template<typename T , size_t N>
MemoryOArchive &	operator& (T(&data)[N])
	Save a fixed size array via operator &.

template<typename T >
void	pack (const T &data)
	Pack a T object.

template<typename T >
void	pack (const T *array, int n)
	Pack a C array.

template<typename T >
void	pack (const T *array, int m, int n, int np)
	Pack a 2D C array.

void	send (MPI::Intracomm &comm, int dest)
	Send packed data via MPI.

void	iSend (MPI::Intracomm &comm, MPI::Request &req, int dest)
	Send packed data via MPI (non-blocking)

Byte *	begin () const
	Return pointer to beginning of block.

Byte *	cursor () const
	Return pointer to current position (cursor).

size_t	capacity () const
	Return capacity in Bytes.

bool	isAllocated () const
	Has memory been allocated?

Static Public Member Functions
static bool	is_saving ()
	Returns true;.

static bool	is_loading ()
	Returns false;.

Detailed Description

Save archive for packed heterogeneous binary data.

Definition at line 31 of file MemoryOArchive.h.

Constructor & Destructor Documentation

◆ MemoryOArchive()

Util::MemoryOArchive::MemoryOArchive ( )

Constructor.

Definition at line 19 of file MemoryOArchive.cpp.

◆ ~MemoryOArchive()

Util::MemoryOArchive::~MemoryOArchive ( )

virtual

Destructor.

Definition at line 33 of file MemoryOArchive.cpp.

References Util::Memory::deallocate().

Member Function Documentation

◆ is_saving()

bool Util::MemoryOArchive::is_saving ( )

inlinestatic

Returns true;.

Definition at line 218 of file MemoryOArchive.h.

◆ is_loading()

bool Util::MemoryOArchive::is_loading ( )

inlinestatic

Returns false;.

Definition at line 221 of file MemoryOArchive.h.

◆ allocate()

void Util::MemoryOArchive::allocate ( size_t capacity )

virtual

Allocate memory.

Parameters

capacity size of memory block in bytes

Definition at line 44 of file MemoryOArchive.cpp.

References Util::Memory::allocate(), begin(), capacity(), and UTIL_THROW.

◆ clear()

void Util::MemoryOArchive::clear ( )

Resets the cursor to the beginning.

Definition at line 62 of file MemoryOArchive.cpp.

References begin(), isAllocated(), and UTIL_THROW.

◆ operator<<() [1/2]

template<typename T >

MemoryOArchive & Util::MemoryOArchive::operator<< ( T & data )

inline

Save (write) one object to this archive via the << operator.

Parameters

data	object of type T to be saved to this archive

Definition at line 254 of file MemoryOArchive.h.

◆ operator&() [1/2]

template<typename T >

MemoryOArchive & Util::MemoryOArchive::operator& ( T & data )

inline

Save (write) one object to this archive via the & operator.

Equivalent to << operator.

Parameters

data	object of type T to be saved to this archive

Definition at line 264 of file MemoryOArchive.h.

◆ operator<<() [2/2]

template<typename T , size_t N>

MemoryOArchive & Util::MemoryOArchive::operator<< ( T(&) data[N] )

inline

Save a fixed size array via operator <<.

The implementation applies the serialize function to each element. This template should thus work for any type T for which a serialize function exists.

Parameters

data	array of fixed size N with elements of type T

Definition at line 274 of file MemoryOArchive.h.

◆ operator&() [2/2]

template<typename T , size_t N>

MemoryOArchive & Util::MemoryOArchive::operator& ( T(&) data[N] )

inline

Save a fixed size array via operator &.

Equivalent to the corresponding << operator.

Parameters

data	array of fixed size N with elements of type T

Definition at line 286 of file MemoryOArchive.h.

◆ pack() [1/3]

template<typename T >

void Util::MemoryOArchive::pack ( const T & data )

inline

Pack a T object.

Definition at line 300 of file MemoryOArchive.h.

References UTIL_THROW.

◆ pack() [2/3]

template<typename T >

void Util::MemoryOArchive::pack	(	const T *	array,
		int	n )

inline

Pack a C array.

Parameters

array	C array
n	number of elements

Definition at line 318 of file MemoryOArchive.h.

References UTIL_THROW.

◆ pack() [3/3]

template<typename T >

void Util::MemoryOArchive::pack	(	const T *	array,
		int	m,
		int	n,
		int	np )

inline

Pack a 2D C array.

Pack m rows of n elements from array of type T array[mp][np], with n <= np and m <= mp.

Parameters

array	poiner to [0][0] element of 2D array
m	logical number of rows
n	logical number of columns
np	physical number of columns

Definition at line 338 of file MemoryOArchive.h.

References UTIL_THROW.

◆ send()

void Util::MemoryOArchive::send	(	MPI::Intracomm &	comm,
		int	dest )

Send packed data via MPI.

Parameters

comm	MPI communicator
dest	rank of processor to which data is sent

Definition at line 74 of file MemoryOArchive.cpp.

References UTIL_THROW.

◆ iSend()

void Util::MemoryOArchive::iSend	(	MPI::Intracomm &	comm,
		MPI::Request &	req,
		int	dest )

Send packed data via MPI (non-blocking)

Parameters

comm	MPI communicator
req	MPI request
dest	rank of processor to which data is sent

Definition at line 97 of file MemoryOArchive.cpp.

References UTIL_THROW.

◆ begin()

Byte * Util::MemoryOArchive::begin ( ) const

inline

Return pointer to beginning of block.

Definition at line 241 of file MemoryOArchive.h.

Referenced by allocate(), and clear().

◆ cursor()

Byte * Util::MemoryOArchive::cursor ( ) const

inline

Return pointer to current position (cursor).

Definition at line 247 of file MemoryOArchive.h.

◆ capacity()

size_t Util::MemoryOArchive::capacity ( ) const

inline

Return capacity in Bytes.

Definition at line 235 of file MemoryOArchive.h.

Referenced by allocate().

◆ isAllocated()

bool Util::MemoryOArchive::isAllocated ( ) const

inline

Has memory been allocated?

Definition at line 229 of file MemoryOArchive.h.

Referenced by clear().

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MemoryOArchive()

◆ ~MemoryOArchive()

Member Function Documentation

◆ is_saving()

◆ is_loading()

◆ allocate()

◆ clear()

◆ operator<<() [1/2]

◆ operator&() [1/2]

◆ operator<<() [2/2]

◆ operator&() [2/2]

◆ pack() [1/3]

◆ pack() [2/3]

◆ pack() [3/3]

◆ send()

◆ iSend()

◆ begin()

◆ cursor()

◆ capacity()

◆ isAllocated()