PSCF v1.1
Public Member Functions | Static Public Member Functions | List of all members
Util::XdrFileOArchive Class Reference

Saving / output archive for binary XDR file. More...

#include <XdrFileOArchive.h>

Public Member Functions

 XdrFileOArchive ()
 Constructor. More...
 
 XdrFileOArchive (std::string filename)
 Constructor. More...
 
virtual ~XdrFileOArchive ()
 Destructor. More...
 
void init (FILE *file)
 Associate with an open file and initialize. More...
 
FILE * file ()
 Get the underlying ifstream by reference. More...
 
template<typename T >
XdrFileOArchiveoperator& (T &data)
 Save one object. More...
 
template<typename T >
XdrFileOArchiveoperator<< (T &data)
 Save one object. More...
 
XDR * xdrPtr ()
 Get a pointer to the enclosed XDR object. More...
 

Static Public Member Functions

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

Detailed Description

Saving / output archive for binary XDR file.

XDR is a standard protocol for writing and reading binary in a portable format. This archive saves data to an associated file in XDR format. It depends on the unix xdr library <rpc/xdr.h>. Because this library is written in C (not C++), this archive uses a standard C library file handle, not a C++ iostream.

Definition at line 39 of file XdrFileOArchive.h.

Constructor & Destructor Documentation

◆ XdrFileOArchive() [1/2]

Util::XdrFileOArchive::XdrFileOArchive ( )

Constructor.

Definition at line 17 of file XdrFileOArchive.cpp.

◆ XdrFileOArchive() [2/2]

Util::XdrFileOArchive::XdrFileOArchive ( std::string  filename)

Constructor.

Parameters
filenamename of file to open for reading.

Definition at line 26 of file XdrFileOArchive.cpp.

References UTIL_THROW.

◆ ~XdrFileOArchive()

Util::XdrFileOArchive::~XdrFileOArchive ( )
virtual

Destructor.

Definition at line 43 of file XdrFileOArchive.cpp.

Member Function Documentation

◆ is_saving()

bool Util::XdrFileOArchive::is_saving ( )
inlinestatic

Returns true;.

Definition at line 111 of file XdrFileOArchive.h.

◆ is_loading()

bool Util::XdrFileOArchive::is_loading ( )
inlinestatic

Returns false;.

Definition at line 114 of file XdrFileOArchive.h.

◆ init()

void Util::XdrFileOArchive::init ( FILE *  file)

Associate with an open file and initialize.

Parameters
fileC file handle, must be open for writing.

Definition at line 49 of file XdrFileOArchive.cpp.

References file().

◆ file()

FILE * Util::XdrFileOArchive::file ( )
inline

Get the underlying ifstream by reference.

Definition at line 142 of file XdrFileOArchive.h.

Referenced by init().

◆ operator&()

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

Save one object.

Definition at line 123 of file XdrFileOArchive.h.

◆ operator<<()

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

Save one object.

Definition at line 133 of file XdrFileOArchive.h.

◆ xdrPtr()

XDR * Util::XdrFileOArchive::xdrPtr ( )
inline

Get a pointer to the enclosed XDR object.

Definition at line 148 of file XdrFileOArchive.h.


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