Util::BinaryFileIArchive Class Reference

Saving archive for binary istream. More...

#include <BinaryFileIArchive.h>

Public Member Functions
	BinaryFileIArchive ()
	Constructor. More...
	BinaryFileIArchive (std::string filename)
	Constructor. More...
	BinaryFileIArchive (std::ifstream &file)
	Constructor. More...
virtual	~BinaryFileIArchive ()
	Destructor. More...
std::ifstream &	file ()
	Get the underlying ifstream by reference. More...
template<typename T >
BinaryFileIArchive &	operator& (T &data)
	Read one object. More...
template<typename T >
BinaryFileIArchive &	operator>> (T &data)
	Read one object. More...
template<typename T >
void	unpack (T &data)
	Unpack a single T object. More...
template<typename T >
void	unpack (T *array, int n)
	Unpack a C array. More...
template<typename T >
void	unpack (T *array, int m, int n, int np)
	Unpack a 2D C array. More...

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

Detailed Description

Saving archive for binary istream.

Definition at line 30 of file BinaryFileIArchive.h.

Constructor & Destructor Documentation

BinaryFileIArchive() [1/3]

Util::BinaryFileIArchive::BinaryFileIArchive

(

)

Constructor.

Definition at line 18 of file BinaryFileIArchive.cpp.

BinaryFileIArchive() [2/3]

Util::BinaryFileIArchive::BinaryFileIArchive

(

std::string

filename

)

Constructor.

Parameters

filename

name of file to open for reading.

Definition at line 27 of file BinaryFileIArchive.cpp.

BinaryFileIArchive() [3/3]

Util::BinaryFileIArchive::BinaryFileIArchive

(

std::ifstream &

file

)

Constructor.

Parameters

file	output file

Definition at line 36 of file BinaryFileIArchive.cpp.

~BinaryFileIArchive()

Util::BinaryFileIArchive::~BinaryFileIArchive ( )

virtual

Destructor.

Definition at line 45 of file BinaryFileIArchive.cpp.

Member Function Documentation

is_saving()

bool Util::BinaryFileIArchive::is_saving ( )

inlinestatic

Returns true;.

Definition at line 128 of file BinaryFileIArchive.h.

is_loading()

bool Util::BinaryFileIArchive::is_loading ( )

inlinestatic

Returns false;.

Definition at line 131 of file BinaryFileIArchive.h.

file()

std::ifstream & Util::BinaryFileIArchive::file

(

)

Get the underlying ifstream by reference.

Definition at line 55 of file BinaryFileIArchive.cpp.

operator&()

template<typename T >

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

inline

Read one object.

Definition at line 140 of file BinaryFileIArchive.h.

operator>>()

template<typename T >

BinaryFileIArchive & Util::BinaryFileIArchive::operator>> ( T &  data )

inline

Read one object.

Definition at line 150 of file BinaryFileIArchive.h.

unpack() [1/3]

template<typename T >

void Util::BinaryFileIArchive::unpack ( T &  data )

inline

Unpack a single T object.

Definition at line 162 of file BinaryFileIArchive.h.

Referenced by Util::CArray2DParam< Type >::loadValue(), and Util::CArrayParam< Type >::loadValue().

unpack() [2/3]

template<typename T >

void Util::BinaryFileIArchive::unpack ( T *  array, int  n  )

inline

Unpack a C array.

Parameters

array	pointer to array (or first element)
n	number of elements

Definition at line 169 of file BinaryFileIArchive.h.

unpack() [3/3]

template<typename T >

void Util::BinaryFileIArchive::unpack ( T *  array, int  m, int  n, int  np  )

inline

Unpack a 2D C array.

This unpacks the elements of an m x n logical array into a physical 2D C array of type array[][np], where np is the physical length of a row, i.e., the amount of memory allocated per row.

Parameters

array	pointer to first row
m	number of rows
n	logical number of columns
np	physical number of columns

Definition at line 180 of file BinaryFileIArchive.h.

---

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

• BinaryFileIArchive.h
• BinaryFileIArchive.cpp