Simpatico  v1.10
List of all members | Public Member Functions | Static Public Member Functions
Util::BinaryFileOArchive Class Reference

Detailed Description

Saving / output archive for binary ostream.

Definition at line 30 of file BinaryFileOArchive.h.

#include <BinaryFileOArchive.h>

Public Member Functions

 BinaryFileOArchive ()
 Constructor. More...
 
 BinaryFileOArchive (std::string filename)
 Constructor. More...
 
 BinaryFileOArchive (std::ofstream &file)
 Constructor. More...
 
virtual ~BinaryFileOArchive ()
 Destructor. More...
 
std::ofstream & file ()
 Get the underlying ifstream by reference. More...
 
template<typename T >
BinaryFileOArchiveoperator& (T &data)
 Save one object. More...
 
template<typename T >
BinaryFileOArchiveoperator<< (T &data)
 Save one object. More...
 
template<typename T >
void pack (const T &data)
 Pack one object of type T. More...
 
template<typename T >
void pack (const T *array, int n)
 Pack a C array. More...
 
template<typename T >
void pack (const T *array, int m, int n, int np)
 Pack a 2D C array. More...
 

Static Public Member Functions

static bool is_saving ()
 Returns true;. More...
 
static bool is_loading ()
 Returns false;. More...
 

Constructor & Destructor Documentation

Util::BinaryFileOArchive::BinaryFileOArchive ( )

Constructor.

Definition at line 16 of file BinaryFileOArchive.cpp.

Util::BinaryFileOArchive::BinaryFileOArchive ( std::string  filename)

Constructor.

Parameters
filenamename of file to open for reading.

Definition at line 25 of file BinaryFileOArchive.cpp.

Util::BinaryFileOArchive::BinaryFileOArchive ( std::ofstream &  file)

Constructor.

Parameters
fileoutput file

Definition at line 34 of file BinaryFileOArchive.cpp.

Util::BinaryFileOArchive::~BinaryFileOArchive ( )
virtual

Destructor.

Definition at line 43 of file BinaryFileOArchive.cpp.

Member Function Documentation

bool Util::BinaryFileOArchive::is_saving ( )
inlinestatic

Returns true;.

Definition at line 126 of file BinaryFileOArchive.h.

bool Util::BinaryFileOArchive::is_loading ( )
inlinestatic

Returns false;.

Definition at line 129 of file BinaryFileOArchive.h.

std::ofstream & Util::BinaryFileOArchive::file ( )

Get the underlying ifstream by reference.

Definition at line 53 of file BinaryFileOArchive.cpp.

Referenced by McMd::MdSimulation::save(), McMd::McSimulation::save(), and DdMd::Simulation::save().

template<typename T >
BinaryFileOArchive & Util::BinaryFileOArchive::operator& ( T &  data)
inline

Save one object.

Definition at line 138 of file BinaryFileOArchive.h.

template<typename T >
BinaryFileOArchive & Util::BinaryFileOArchive::operator<< ( T &  data)
inline

Save one object.

Definition at line 148 of file BinaryFileOArchive.h.

template<typename T >
void Util::BinaryFileOArchive::pack ( const T &  data)
inline
template<typename T >
void Util::BinaryFileOArchive::pack ( const T *  array,
int  n 
)
inline

Pack a C array.

Parameters
arrayaddress of first element
nnumber of elements

Definition at line 167 of file BinaryFileOArchive.h.

template<typename T >
void Util::BinaryFileOArchive::pack ( const T *  array,
int  m,
int  n,
int  np 
)
inline

Pack a 2D C array.

This packs m rows of length n within a 2D C array allocated as array[][np], where np is the physical length of one row.

Parameters
arraypointer to [0][0] element in 2D array
mnumber of rows
nlogical number of columns
npphysical number of columns

Definition at line 178 of file BinaryFileOArchive.h.

References pack().


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