File Class Reference

A basic input/output file class. More...

#include <communicator.h>

Public Member Functions
	File (string, string, string, string)
	Constructor. More...
	File (string)
	Constructor. More...
fstream &	stream ()
void	open (ios_base::openmode)
	Open the file. More...
void	reset ()
	Reset a file. More...
void	rename ()
	Rename a file. More...
void	close ()
	Close the file.
bool	exists ()
	did the file exist before opening?

Protected Member Functions
void	open (ios_base::openmode, string)
	Open the file. More...

Protected Attributes
string	name
string	bakname
bool	exists_
fstream	rwfile

Friends
class	Communicator

Detailed Description

A basic input/output file class.

Definition at line 25 of file communicator.h.

Constructor & Destructor Documentation

File() [1/2]

File::File	(	string	_type,
		string	_data,
		string	ensemble,
		string	outDir
	)

Constructor.

Given a file type/label, ensemble type, data label and out directory, create a unique file name and backup file name.

Parameters

_type	The file type: state, log, etc
_data	The unique data string identifier
ensemble	ce: canonical, gce: grand canonical
outDir	The output directory

Definition at line 28 of file communicator.cpp.

                                                                     {
 
    /* The file name */
    name = str(format("%s/%s-%s-%s.dat") % outDir % ensemble % _type % _data);
 
    /* Create a backup name */
    bakname = str(format("%s/%s-%s-%s.bak") % outDir % ensemble % _type % _data);
 
    /* Determine if the file already exists */
    exists_ = filesystem::exists(name);
}

File() [2/2]

File::File

(

string

_name

)

Constructor.

Create a filename from a string.

Parameters

_name

A file name.

Definition at line 47 of file communicator.cpp.

                       : name(_name), bakname() {
 
}

Member Function Documentation

open() [1/2]

void File::open

(

ios_base::openmode

mode

)

Open the file.

Parameters

mode	A valid file rw mode

Definition at line 64 of file communicator.cpp.

                                     {
 
    /* Convert the filename to a c string, and open the file */ 
    rwfile.open(name.c_str(), mode);
    if (!rwfile) {
        cerr << "Unable to process file: " << name << endl;
        exit(EXIT_FAILURE);
    }
}

Here is the caller graph for this function:

open() [2/2]

void File::open ( ios_base::openmode  mode, string  _name  )

protected

Open the file.

Parameters

mode	A valid file rw mode
_name	A valid file name

Definition at line 80 of file communicator.cpp.

                                                   {
 
    /* Convert the filename to a c string, and open the file */ 
    rwfile.open(_name.c_str(), mode);
    if (!rwfile) {
        cerr << "Unable to process file: " << _name << endl;
        exit(EXIT_FAILURE);
    }
}

rename()

void File::rename

(

)

Rename a file.

After we have performed a write to a .bak file, we rename it to .dat

Definition at line 112 of file communicator.cpp.

                  {
 
    close();
 
    /* /1* Create the filesystem paths *1/ */
    /* boost::filesystem::path datpath(name); */
    /* boost::filesystem::path bakpath(bakname); */
 
    /* Perform the rename */
    filesystem::rename(bakname.c_str(), name.c_str());
}

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void File::reset

(

)

Reset a file.

This method is used to prepare a file for writing that is meant to be overwritten. In order to be safe, we write to a .bak version of the file.

Definition at line 96 of file communicator.cpp.

                 {
 
    /* Close the current file */
    close();
 
    /* Open a backup file and replace any content if it exists */
    open(ios::out|ios::trunc,bakname);
 
    /* Write the generic header to the file */
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• include/communicator.h
• src/communicator.cpp