#include <File.h>

Public Member Functions
	File ()
	constructor More...

virtual	~File ()
	destructor More...

std::fstream &	getFstream ()
	Allows to access the member variable File::fstream_. More...

const std::string &	getName () const
	Allows to access the file name, e.g., "problem.data". More...

const std::string	getFullName () const
	Also allows to access the file name, however with additional information which is the file counter, e.g., "problem.data.0000". More...

void	setName (const std::string &name)
	Sets the file name, e.g. "Name.data". More...

FileType	getFileType () const
	Gets the file type e.g. NOFILE, ONEFILE and MULTIPLE FILES. File::fileType_. More...

void	setFileType (FileType fileType)
	Sets the type of file needed to write into or read from. File::fileType_. More...

unsigned int	getCounter () const
	In case of multiple files, File::getCounter() returns the the number (FILE::Counter_) of the next file i.e. to be opened for reading or writing; NOTE: needed only if FILE::fileType_ is multiple files. More...

void	setCounter (unsigned int counter)
	Allows the user to set the file counter according to his need. Sets File::counter_. More...

std::fstream::openmode	getOpenMode () const
	Allows the user to know the file mode i.e. gets File::openMode_. More...

void	setOpenMode (std::fstream::openmode openMode)
	Allows the user to Sets File::openMode_. More...

unsigned int	getSaveCount () const
	Gets File::saveCount_. More...

void	setSaveCount (unsigned int saveCount)
	Sets File::saveCount_. More...

unsigned int	getNextSavedTimeStep () const
	Gets File::nextSavedTimeStep_. More...

void	setNextSavedTimeStep (unsigned int nextSavedTimeStep)
	Sets File::nextSavedTimeStep_. More...

bool	saveCurrentTimestep (unsigned int ntimeSteps)

void	read (std::istream &is)
	read function, which accepts an input stream std::istream. More...

void	write (std::ostream &os) const
	print function, which accepts an std::stringstream as input. More...

bool	open ()
	Checks if the file stream fstream_ has any issues while opening. Alongside, it also increments the nextSavedTimeStep and the counter. the counter is useful when the fileType_ is set to Multiple or Multiple with padded. More...

bool	open (std::fstream::openmode openMode)
	First calls setOpenMode(openMode), then open(). More...

bool	openNextFile ()
	This function should be called before a data corresponding to the new time step is written or read. It is essential in case of multiple files, as it opens a new file for every increment in the File::counter_. More...

bool	openNextFile (std::fstream::openmode openMode)
	Similar to File::openNextFile(), but also lets the user set the mode of opening, see std::fstream::openmode More...

void	close ()
	Closes the file by calling fstream_.close() More...

Private Attributes
std::string	name_
	name of the file. More...

std::fstream	fstream_
	Stream object used to read/write data files. More...

FileType	fileType_
	fileType_ indicates the type of the files. Whether it is No file, one file or multiple file as described in the description of the class. More...

unsigned int	counter_
	counts the number of the next file to be opened; needed if multiple files are written/read More...

std::fstream::openmode	openMode_
	A variable to indicate how the file should be opened i.e. in, out, ... see http://en.cppreference.com (std::fstream::out by default) More...

unsigned int	saveCount_
	Allows one to define the number of timesteps to be skipped to make a snap shot. E.g. TMax = 100, saveCount_ = 10, timeStep = 1; It stores data at t={0,10,20,30,40...100}. And if TMax =101, it stores data at t={0,10,20,30,...100,101}. More...

unsigned int	nextSavedTimeStep_
	the time step at which the next write or read operation has to happen. More...

Friends
std::ostream &	operator<< (std::ostream &os, const File &o)
	Operator overloading used to write data obtained from an object of class File into an output stream. It also returns a reference to the output stream. More...

std::istream &	operator>> (std::istream &is, File &o)
	Operator overloading used to read data from the input stream into member variables of an object of class File. It also returns a reference of type std::istream&. More...

Detailed Description

The instance of class File, for e.g. member variables of class Files (objects of type File) in Files.h, allows to manipulate the the input and output stream. In layman terms: In MercuryDPM, in order to read and write data into or from files we use the methods defined in Files.h. These methods implicitly calls the methods of class File and thereby allowing us to write or read data.

Definition at line 78 of file File.h.

Constructor & Destructor Documentation

File::File ( )

constructor

A File constructor which initialises FILE::saveCount_=0, sets the default filename as FILE::name_ = "", sets the default FileType to be as FileType::ONE_FILE and few other variables as listed below.

Definition at line 120 of file File.cc.

References counter_, fileType_, name_, nextSavedTimeStep_, ONE_FILE, openMode_, and saveCount_.

 {
     saveCount_ = 0;
 
     // file name has to be set by the user
     name_ = "out";
     
     // file closed by default
     
     // output into a single file by default
     fileType_ = FileType::ONE_FILE;
     
     // file counter set to 0 by default
     counter_ = 0;
     nextSavedTimeStep_ = 0;
 
     // file output file by default
     openMode_ = std::fstream::out;
 }

File::~File ( )

virtual

destructor

Definition at line 143 of file File.cc.

144 {

145 }

Member Function Documentation

void File::close ( )

Closes the file by calling fstream_.close()

Definition at line 362 of file File.cc.

References fstream_.

Referenced by Files::closeFiles(), openNextFile(), DPMBase::readDataFile(), DPMBase::readRestartFile(), and DPMBase::writeOutputFiles().

 {
     fstream_.close();
     //std::cerr << "Closing " << getFullName() << std::endl;
 }

unsigned int File::getCounter ( ) const

In case of multiple files, File::getCounter() returns the the number (FILE::Counter_) of the next file i.e. to be opened for reading or writing; NOTE: needed only if FILE::fileType_ is multiple files.

Returns: unsigned int counter_

Definition at line 217 of file File.cc.

References counter_.

Referenced by DPMBase::findNextExistingDataFile(), getFullName(), and DPMBase::writeOutputFiles().

 {
     return counter_;
 }

FileType File::getFileType ( ) const

Gets the file type e.g. NOFILE, ONEFILE and MULTIPLE FILES. File::fileType_.

Returns: Returns the FileType (File::fileType_)

Definition at line 203 of file File.cc.

References fileType_.

Referenced by DPMBase::findNextExistingDataFile(), getFullName(), openNextFile(), DPMBase::readDataFile(), saveCurrentTimestep(), and DPMBase::writeOutputFiles().

 {
     return fileType_;
 }

std::fstream & File::getFstream ( )

Allows to access the member variable File::fstream_.

Returns fstream (file stream) of any file for input and output tasks.

Returns: std::fstream&

Definition at line 151 of file File.cc.

References fstream_.

Referenced by Files::Files(), DPMBase::findNextExistingDataFile(), DPMBase::readDataFile(), Mercury3DRestart::readNextArgument(), DPMBase::readNextDataFile(), DPMBase::readRestartFile(), DPMBase::writeOutputFiles(), and DPMBase::writeRestartFile().

 {
     return fstream_;
 }

const std::string File::getFullName ( ) const

Also allows to access the file name, however with additional information which is the file counter, e.g., "problem.data.0000".

In case of FileType:fileType_== multiple files or multiple files padded, multiple files are generated and are named as problem.data.0, problem.data.1 or problem.data.0000, problem.data.0001

Returns: Returns a constant of type std::string

Definition at line 171 of file File.cc.

References getCounter(), getFileType(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, and name_.

Referenced by open(), and write().

 {
     //get the full file name
     std::stringstream fullFileName("");
     fullFileName << name_;
     if (getFileType() == FileType::MULTIPLE_FILES)
     {
         fullFileName << "." << getCounter();
     }
     else if (getFileType() == FileType::MULTIPLE_FILES_PADDED)
     {
         fullFileName << ".";
         if (getCounter() < 1000)
             fullFileName << "0";
         if (getCounter() < 100)
             fullFileName << "0";
         if (getCounter() < 10)
             fullFileName << "0";
         fullFileName << getCounter();
     }
     return fullFileName.str();
 }

const std::string & File::getName ( ) const

Allows to access the file name, e.g., "problem.data".

Returns: Returns a constant reference of type const std::string&

Definition at line 163 of file File.cc.

References name_.

Referenced by DPMBase::findNextExistingDataFile(), main(), open(), DPMBase::readDataFile(), and Mercury3DRestart::readNextArgument().

 {
     return name_;
 }

unsigned int File::getNextSavedTimeStep ( ) const

Gets File::nextSavedTimeStep_.

Returns the time step at which the next write or read operation has to happen

Returns: unsigned int nextSaveTimeStep_

Definition at line 292 of file File.cc.

References nextSavedTimeStep_.

 {
     return nextSavedTimeStep_;
 }

std::fstream::openmode File::getOpenMode ( ) const

Allows the user to know the file mode i.e. gets File::openMode_.

Returns: std::fstream::openmode

Definition at line 261 of file File.cc.

References openMode_.

 {
     return openMode_;
 }

unsigned int File::getSaveCount ( ) const

Gets File::saveCount_.

Returns: unsigned int saveCount_

Definition at line 275 of file File.cc.

References saveCount_.

Referenced by DPMBase::readNextArgument().

 {
     return saveCount_;
 }

bool File::open ( )

Checks if the file stream fstream_ has any issues while opening. Alongside, it also increments the nextSavedTimeStep and the counter. the counter is useful when the fileType_ is set to Multiple or Multiple with padded.

Returns a bool to check if the file is open or closed. It also increments the nextSavedTimeStep with the saveCount

Returns: bool (True or False)

Bug:: Deepak checked by using fstream_.fail() instead of !fstrea_.is_open(), however this breaks selftests, Thomas will look at this

Todo:: tw: DEBUG_OUTPUT is currently only defined in DPMBase.h

Definition at line 320 of file File.cc.

References helpers::compare(), counter_, fileType_, fstream_, getFullName(), getName(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, nextSavedTimeStep_, openMode_, and saveCount_.

Referenced by main(), open(), Files::openFiles(), openNextFile(), DPMBase::readDataFile(), DPMBase::readRestartFile(), and saveCurrentTimestep().

 {  
     if (getName().compare("") == 0)
     {
         std::cerr << "Error: Name must be set before opening file" << std::endl;
         throw;
     }
 
     //close old file if multi-file output
     if (fileType_==FileType::MULTIPLE_FILES||fileType_==FileType::MULTIPLE_FILES_PADDED)
         fstream_.close();
     
     //open new file for multi-file output
     
     if (!fstream_.is_open())
     {
         fstream_.open(getFullName().c_str(), openMode_);
         if (!fstream_.is_open())
         {
             //logger(WARN, "Could not open % with open mode %", getFullName(), openMode_);
             return false;
         }
     }
     #ifdef DEBUG_OUTPUT
         std::cout << "open " << getFullName() << std::endl;
     #endif
     nextSavedTimeStep_ += saveCount_;
     counter_++;  
     return true;
 }

bool File::open ( std::fstream::openmode openMode )

First calls setOpenMode(openMode), then open().

Parameters

[in] openMode

Definition at line 354 of file File.cc.

References open(), and setOpenMode().

 {
     setOpenMode(openMode);
     return open();
 }

bool File::openNextFile ( )

This function should be called before a data corresponding to the new time step is written or read. It is essential in case of multiple files, as it opens a new file for every increment in the File::counter_.

Returns: bool (True or False)

Definition at line 231 of file File.cc.

References close(), getFileType(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, and open().

Referenced by DPMBase::findNextExistingDataFile(), openNextFile(), and DPMBase::readNextDataFile().

 {
     //++counter_;
 
     if (getFileType() == FileType::MULTIPLE_FILES || getFileType() == FileType::MULTIPLE_FILES_PADDED)
     {
         File::close();
         return File::open();
     }
 //    else if (getFileType() == FileType::ONE_FILE && !getFstream().is_open())
 //    {
 //        return File::open();
 //    }
     else
     {
         return true;
     }
 }

bool File::openNextFile ( std::fstream::openmode openMode )

Similar to File::openNextFile(), but also lets the user set the mode of opening, see std::fstream::openmode

Parameters

[in] openmode

Returns: bool

Definition at line 253 of file File.cc.

References openNextFile(), and setOpenMode().

 {
     setOpenMode(openMode);
     return openNextFile();
 }

void File::read ( std::istream & is )

read function, which accepts an input stream std::istream.

Read function, which accepts an input stream object as input and assigns the member variables i.e. name_, fileType_, saveCount_, counter_ and nextSavedTimeStep_

Parameters

[in,out] is

Definition at line 372 of file File.cc.

References counter_, fileType_, name_, nextSavedTimeStep_, and saveCount_.

Referenced by operator>>().

 {
     std::string dummy;
     is >> dummy;
     if (!dummy.compare("name"))
         is >> name_ >> dummy;
     is >> fileType_;
     is >> dummy >> saveCount_;
     is >> dummy >> counter_;
     is >> dummy >> nextSavedTimeStep_;
 }

bool File::saveCurrentTimestep ( unsigned int ntimeSteps )

Parameters

[in] ntimeSteps

Returns: True or False (a bool)

Definition at line 309 of file File.cc.

References getFileType(), nextSavedTimeStep_, NO_FILE, and open().

Referenced by DPMBase::writeOutputFiles().

 {
     //check if this timestep should be written, if the file type is not NO_FILE, then open the file and check if the file was successfully opened
     //std::cout << (ntimeSteps>=nextSavedTimeStep_) << " " <<  (getFileType()!= FileType::NO_FILE) << std::endl;
     return ntimeSteps>=nextSavedTimeStep_ && getFileType()!= FileType::NO_FILE && open();
 }

void File::setCounter ( unsigned int counter )

Allows the user to set the file counter according to his need. Sets File::counter_.

Parameters

[in] counter

Definition at line 224 of file File.cc.

References counter_.

Referenced by main(), and Files::resetFileCounter().

 {
     counter_ = counter;
 }

void File::setFileType ( FileType fileType )

Sets the type of file needed to write into or read from. File::fileType_.

Parameters

[in] fileType

Definition at line 210 of file File.cc.

References fileType_.

Referenced by ChuteBottom::constructor(), DPMBase::readDataFile(), DPMBase::readNextArgument(), DPMBase::readOld(), and Files::setFileType().

 {
     fileType_ = fileType;
 }

void File::setName ( const std::string & name )

Sets the file name, e.g. "Name.data".

Note the file name is usually set by MD::setName(), which sets names for all file types (data, restart, fstat, stat, ene)

Parameters

[in] name (Takes in the to be name of the File)

Definition at line 196 of file File.cc.

References name_.

Referenced by main(), DPMBase::readDataFile(), DPMBase::readRestartFile(), and Files::setName().

 {
     this->name_ = name;
 }

void File::setNextSavedTimeStep ( unsigned int nextSavedTimeStep )

Sets File::nextSavedTimeStep_.

Allows one to set the time step at which the next write or read operation has to happen

Parameters

[in] nextSavedTimeStep

Definition at line 300 of file File.cc.

References nextSavedTimeStep_.

Referenced by Files::setNextSavedTimeStep().

 {
     nextSavedTimeStep_ = nextSavedTimeStep;
 }

void File::setOpenMode ( std::fstream::openmode openMode )

Allows the user to Sets File::openMode_.

Parameters

[in] openmode

Definition at line 268 of file File.cc.

References openMode_.

Referenced by open(), openNextFile(), Files::setOpenMode(), and DPMBase::solve().

 {
     openMode_ = openMode;
 }

void File::setSaveCount ( unsigned int saveCount )

Sets File::saveCount_.

File::setSaveCount assigns the number of time steps to be skipped before the data is written to an existing file or a new file.

Parameters

[in] saveCount

Bug:: TW: should setSaveCount change nextSavedTimeStep_ as well?

Definition at line 283 of file File.cc.

References saveCount_.

Referenced by DPMBase::readNextArgument(), DPMBase::readOld(), DPMBase::readParAndIniFiles(), and Files::setSaveCount().

 {
     saveCount_ = saveCount;
 }

void File::write ( std::ostream & os ) const

print function, which accepts an std::stringstream as input.

BaseParticle print function, which accepts an output stream object as input and writes the info to the std::ostream

Parameters

[in,out] os

Todo:: TW: openMode_ is not saved, maybe it should not even be stored but set every time you open a file

Definition at line 388 of file File.cc.

References helpers::compare(), counter_, fileType_, getFullName(), name_, nextSavedTimeStep_, and saveCount_.

Referenced by operator<<().

 {
     //only write name if it differs from the default name
     if (getFullName().compare(name_))
         os << "name " << name_ << " ";
     os << "fileType " << fileType_;
     os << " saveCount " << saveCount_;
     os << " counter " << counter_;
     os << " nextSavedTimeStep " << nextSavedTimeStep_;
 }

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const File &	o
	)

friend

Operator overloading used to write data obtained from an object of class File into an output stream. It also returns a reference to the output stream.

Parameters

[in,out]	os
[in]	o

Returns: std::ostream& os

Definition at line 404 of file File.cc.

 {
     o.write(os);
     return os;
 }

std::istream& operator>>	(	std::istream &	is,
		File &	o
	)

friend

Operator overloading used to read data from the input stream into member variables of an object of class File. It also returns a reference of type std::istream&.

Parameters

[in,out]	is
[in]	o

Returns: std::istream&

Definition at line 414 of file File.cc.

 {
     o.read(is);
     return (is);
 }

Member Data Documentation

unsigned int File::counter_

private

counts the number of the next file to be opened; needed if multiple files are written/read

Definition at line 241 of file File.h.

Referenced by File(), getCounter(), open(), read(), setCounter(), and write().

FileType File::fileType_

private

fileType_ indicates the type of the files. Whether it is No file, one file or multiple file as described in the description of the class.

Definition at line 236 of file File.h.

Referenced by File(), getFileType(), open(), read(), setFileType(), and write().

std::fstream File::fstream_

private

Stream object used to read/write data files.

Definition at line 230 of file File.h.

Referenced by close(), getFstream(), and open().

std::string File::name_

private

name of the file.

Definition at line 225 of file File.h.

Referenced by File(), getFullName(), getName(), read(), setName(), and write().

unsigned int File::nextSavedTimeStep_

private

the time step at which the next write or read operation has to happen.

Definition at line 257 of file File.h.

Referenced by File(), getNextSavedTimeStep(), open(), read(), saveCurrentTimestep(), setNextSavedTimeStep(), and write().

std::fstream::openmode File::openMode_

private

A variable to indicate how the file should be opened i.e. in, out, ... see http://en.cppreference.com (std::fstream::out by default)

Definition at line 246 of file File.h.

Referenced by File(), getOpenMode(), open(), and setOpenMode().

unsigned int File::saveCount_

private

Allows one to define the number of timesteps to be skipped to make a snap shot. E.g. TMax = 100, saveCount_ = 10, timeStep = 1; It stores data at t={0,10,20,30,40...100}. And if TMax =101, it stores data at t={0,10,20,30,...100,101}.

Definition at line 252 of file File.h.

Referenced by File(), getSaveCount(), open(), read(), setSaveCount(), and write().

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

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation