#include <File.h>

Public Member Functions
	File ()
	constructor More...

	File (const File &)
	default copy 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...

const std::string	getFullName (unsigned) const
	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...

void	increaseCounter ()

void	decreaseCounter ()

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	writeFirstAndLastTimeStep ()
	Sets File::saveCount_ to the highest possible value such that only the first and last time step is written. More...

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

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

void	setLastSavedTimeStep (unsigned int lastSavedTimeStep)
	Sets File::nextSavedTimeStep_. More...

bool	saveCurrentTimeStep (unsigned int ntimeSteps)
	determined if this time step has to be written; if so, opens the output file More...

bool	saveCurrentTimeStepNoFileTypeCheck (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	openWrite (unsigned)
	First sets openmode to write (and append in some cases), then calls open(). More...

bool	openWriteNoAppend (unsigned)

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

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

void	setlogarithmicSaveCount (const Mdouble logarithmicSaveCountBase)
	the function to set the user input base of logarithmic saving count 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 already opened files, i.e. counter=1 means .0000 exists 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 time steps 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...

Mdouble	logarithmicSaveCountBase_
	the switch allow user to set saveCount in logarithmic timescale with equal distance , the number is the base of log scale from user input More...

unsigned int	lastSavedTimeStep_
	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 80 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 102 of file File.cc.

References counter_, fileType_, lastSavedTimeStep_, logarithmicSaveCountBase_, name_, NEVER, ONE_FILE, openMode_, and saveCount_.

 {
     //sets the default for the number of time steps to be skipped
     //in between each saved "snapshot" of the system to zero
     //(i.e. records every time step by default)
     saveCount_ = 0;
     
     // file name has to be set by the user
     name_ = "out";
     
     // output into a single file by default
     fileType_ = FileType::ONE_FILE;
     
     // counter of currently open file set to 0 by default
     counter_ = 0;
     
     //stores the time step of the last write/read operation; NEVER by default
     lastSavedTimeStep_ = NEVER;
     
     //sets the default openMode to "out"
     //i.e. files will by default be written to, not read from.
     openMode_ = std::fstream::out;
     
     //sets the default logarithmicSaveCount to zero
     logarithmicSaveCountBase_ = 0;
 }

File::File ( const File & f )

default copy constructor

Copy everything but the fstream object (which cannot be copied).

Parameters

[in] f the file object that is to be copied.

Definition at line 133 of file File.cc.

References counter_, fileType_, lastSavedTimeStep_, logarithmicSaveCountBase_, name_, openMode_, and saveCount_.

 {
     saveCount_ = f.saveCount_;
     name_ = f.name_;
     fileType_ = f.fileType_;
     counter_ = f.counter_;
     lastSavedTimeStep_ = f.lastSavedTimeStep_;
     openMode_ = f.openMode_;
     logarithmicSaveCountBase_ = f.logarithmicSaveCountBase_;
 }

File::~File ( )

virtualdefault

destructor

Destructor

Member Function Documentation

void File::close ( )

Closes the file by calling fstream_.close()

Definition at line 408 of file File.cc.

References fstream_.

Referenced by DPMBase::closeFiles(), CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), DPMBase::readDataFile(), DPMBase::readRestartFile(), DPMBase::writeDataFile(), DPMBase::writeEneFile(), DPMBase::writeFStatFile(), and DPMBase::writeRestartFile().

 {
     fstream_.close();
 }

void File::decreaseCounter ( )

inline

Definition at line 150 of file File.h.

References counter_.

Referenced by CGHandler::restart().

150 {counter_--;}

File::counter_

unsigned int counter_

counts the number of already opened files, i.e. counter=1 means .0000 exists

Definition: File.h:265

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 224 of file File.cc.

References counter_.

Referenced by DPMBase::findNextExistingDataFile(), getFullName(), main(), openWrite(), DPMBase::readDataFile(), DPMBase::writeEneTimeStep(), 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 208 of file File.cc.

References fileType_.

Referenced by BaseInteraction::BaseInteraction(), DPMBase::findNextExistingDataFile(), getFullName(), openWrite(), DPMBase::readDataFile(), saveCurrentTimeStep(), DPMBase::writeEneTimeStep(), DPMBase::writeOutputFiles(), and BaseInteraction::~BaseInteraction().

 {
     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 154 of file File.cc.

References fstream_.

Referenced by BaseCG::BaseCG(), BaseInteraction::BaseInteraction(), DPMBase::constructor(), DPMBase::findNextExistingDataFile(), DPMBase::readDataFile(), DPMBase::readNextDataFile(), DPMBase::readNextFStatFile(), DPMBase::readRestartFile(), DPMBase::writeDataFile(), DPMBase::writeEneFile(), DPMBase::writeFStatFile(), DPMBase::writeRestartFile(), and BaseInteraction::~BaseInteraction().

 {
     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".

Definition at line 171 of file File.cc.

References getCounter().

Referenced by CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), main(), open(), DPMBase::readDataFile(), DPMBase::readRestartFile(), CGHandler::restart(), and write().

 {
     return getFullName(getCounter() - 1);
 }

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

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 180 of file File.cc.

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

 {
     //get the full file name
     std::stringstream lastName("");
     lastName << name_;
     if (getFileType() == FileType::MULTIPLE_FILES)
     {
         lastName << "." << counter;
     }
     else if (getFileType() == FileType::MULTIPLE_FILES_PADDED)
     {
         lastName << "." << to_string_padded(counter);
     }
     return lastName.str();
 }

unsigned int File::getLastSavedTimeStep ( ) 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 294 of file File.cc.

References lastSavedTimeStep_.

 {
     return lastSavedTimeStep_;
 }

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 166 of file File.cc.

References name_.

Referenced by DPMBase::findNextExistingDataFile(), DPMBase::read(), DPMBase::readDataFile(), Mercury3DRestart::readNextArgument(), CGHandler::restart(), and setName().

 {
     return name_;
 }

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 240 of file File.cc.

References openMode_.

 {
     return openMode_;
 }

unsigned int File::getSaveCount ( ) const

Gets File::saveCount_.

Returns: unsigned int saveCount_

Definition at line 256 of file File.cc.

References saveCount_.

Referenced by DPMBase::readNextArgument().

 {
     return saveCount_;
 }

void File::increaseCounter ( )

inline

Definition at line 148 of file File.h.

References counter_.

148 {counter_++;}

File::counter_

unsigned int counter_

counts the number of already opened files, i.e. counter=1 means .0000 exists

Definition: File.h:265

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

Definition at line 348 of file File.cc.

References counter_, fileType_, fstream_, getFullName(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, and openMode_.

Referenced by DPMBase::findNextExistingDataFile(), open(), openWrite(), openWriteNoAppend(), DPMBase::readDataFile(), DPMBase::readNextDataFile(), DPMBase::readNextFStatFile(), DPMBase::readRestartFile(), and DPMBase::solve().

 {
     //close old file if multi-file output
     if (fileType_ == FileType::MULTIPLE_FILES || fileType_ == FileType::MULTIPLE_FILES_PADDED)
     {
         fstream_.close();
     }
     
     counter_++;
     
     if (!fstream_.is_open())
     {
         fstream_.open(getFullName().c_str(), openMode_);
         if (!fstream_.is_open())
         {
             return false;
         }
     }
     
     return true;
 }

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

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

Parameters

[in] openMode

Definition at line 373 of file File.cc.

References open(), and setOpenMode().

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

bool File::openWrite ( unsigned nTimeSteps )

First sets openmode to write (and append in some cases), then calls open().

Parameters

[in] openMode

Definition at line 382 of file File.cc.

References getCounter(), getFileType(), ONE_FILE, open(), setLastSavedTimeStep(), and setOpenMode().

Referenced by DPMBase::writeDataFile(), DPMBase::writeEneFile(), and DPMBase::writeFStatFile().

 {
     setLastSavedTimeStep(nTimeSteps);
     if (getFileType() == FileType::ONE_FILE && getCounter() != 0)
     {
         setOpenMode(std::fstream::out | std::fstream::app);
     }
     else
     {
         setOpenMode(std::fstream::out);
     }
     return open();
 }

bool File::openWriteNoAppend ( unsigned nTimeSteps )

Parameters

[in] openMode

Definition at line 399 of file File.cc.

References open(), and setLastSavedTimeStep().

Referenced by DPMBase::writeRestartFile().

 {
     setLastSavedTimeStep(nTimeSteps);
     return open(std::fstream::out);
 }

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 lastSavedTimeStep_

Parameters

[in,out] is

Definition at line 418 of file File.cc.

References counter_, fileType_, lastSavedTimeStep_, name_, NEVER, 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_;
     if (counter_ != 0)
     {
         is >> dummy >> lastSavedTimeStep_;
     }
     else
     {
         lastSavedTimeStep_ = NEVER;
     }
     //if (dummy != "lastSavedTimeStep") lastSavedTimeStep_=SAVE;
 }

bool File::saveCurrentTimeStep ( unsigned int ntimeSteps )

determined if this time step has to be written; if so, opens the output file

Parameters

[in] ntimeSteps

Returns: True or False (a bool)

Definition at line 313 of file File.cc.

References getFileType(), NO_FILE, and saveCurrentTimeStepNoFileTypeCheck().

Referenced by CGHandler::evaluate(), and DPMBase::writeOutputFiles().

                                                       {
     return getFileType() != FileType::NO_FILE && saveCurrentTimeStepNoFileTypeCheck(ntimeSteps);
 }

bool File::saveCurrentTimeStepNoFileTypeCheck ( unsigned int ntimeSteps )

Definition at line 318 of file File.cc.

References lastSavedTimeStep_, logarithmicSaveCountBase_, NEVER, and saveCount_.

Referenced by saveCurrentTimeStep(), and DPMBase::writeOutputFiles().

 {
     /* check:
      * - if this time step should be written
      * - if the file type is not NO_FILE
      * - if file can be opened
      * in that case, change lastSavedTimeStep and return true;
      */
     if ((lastSavedTimeStep_ == NEVER || ntimeSteps >= lastSavedTimeStep_ + saveCount_))
     {
         //note: do not do the following at t = 0 because this makes no sense for a logarithm
         if (logarithmicSaveCountBase_ > 1 && ntimeSteps > 0 &&
             saveCount_ < ceil((logarithmicSaveCountBase_ - 1) * lastSavedTimeStep_))
         {
             /*calculate the new saveCount base on the user input logarithmicSaveCountBase,
              *and multiply by the actual number of time steps
              */
             saveCount_ = ceil((logarithmicSaveCountBase_ - 1) * lastSavedTimeStep_);
         }
         return true;
     } else {
         return false;
     }
 }

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 232 of file File.cc.

References counter_.

Referenced by CGHandler::evaluateDataFiles(), main(), DPMBase::readDataFile(), DPMBase::readRestartFile(), and DPMBase::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 216 of file File.cc.

References fileType_.

Referenced by BaseCluster::actionsOnRestart(), DPMBase::constructor(), ChuteBottom::constructor(), DPMBase::readDataFile(), DPMBase::readNextArgument(), DPMBase::readOld(), DPMBase::setFileType(), and BaseCluster::setupInitialConditions().

 {
     fileType_ = fileType;
 }

void File::setLastSavedTimeStep ( unsigned int lastSavedTimeStep )

Sets File::nextSavedTimeStep_.

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

Parameters

[in] lastSavedTimeStep

Definition at line 303 of file File.cc.

References lastSavedTimeStep_.

Referenced by BaseCG::BaseCG(), CGHandler::evaluate(), CGHandler::finish(), openWrite(), openWriteNoAppend(), DPMBase::setLastSavedTimeStep(), and DPMBase::writeOutputFiles().

 {
     lastSavedTimeStep_ = lastSavedTimeStep;
 }

void File::setlogarithmicSaveCount ( const Mdouble logarithmicSaveCountBase )

the function to set the user input base of logarithmic saving count

File::setlogarithmicSaveCount assigns the base of the saveCount on a logarithmic time scale

Parameters

[in] logarithmicSaveCountBase

Definition at line 284 of file File.cc.

References logarithmicSaveCountBase_, and logger.

Referenced by DPMBase::setLogarithmicSaveCount().

 {
     logger.assert_always(logarithmicSaveCountBase > 1, "logarithmicSaveCountBase should always be larger than 1");
     logarithmicSaveCountBase_ = logarithmicSaveCountBase;
 }

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 199 of file File.cc.

References getName(), logger, and name_.

Referenced by DPMBase::read(), DPMBase::readDataFile(), DPMBase::readRestartFile(), CGHandler::restart(), and DPMBase::setName().

 {
     logger.assert_always(!getName().empty(), "Error: Name cannot be empty");
     this->name_ = name;
 }

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

Allows the user to Sets File::openMode_.

Parameters

[in] openmode

Definition at line 248 of file File.cc.

References openMode_.

Referenced by open(), openWrite(), DPMBase::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

Definition at line 274 of file File.cc.

References saveCount_.

Referenced by DPMBase::readNextArgument(), DPMBase::readOld(), DPMBase::readParAndIniFiles(), and DPMBase::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 443 of file File.cc.

References helpers::compare(), counter_, fileType_, getFullName(), lastSavedTimeStep_, name_, 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_;
     if (counter_ != 0)
     {
         os << " lastSavedTimeStep " << lastSavedTimeStep_;
     }
 }

void File::writeFirstAndLastTimeStep ( )

Sets File::saveCount_ to the highest possible value such that only the first and last time step is written.

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

Definition at line 265 of file File.cc.

References NEVER, and saveCount_.

 {
     saveCount_ = NEVER;
 }

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 463 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 474 of file File.cc.

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

Member Data Documentation

unsigned int File::counter_

private

counts the number of already opened files, i.e. counter=1 means .0000 exists

Definition at line 265 of file File.h.

Referenced by decreaseCounter(), File(), getCounter(), increaseCounter(), 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 260 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 254 of file File.h.

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

unsigned int File::lastSavedTimeStep_

private

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

Definition at line 287 of file File.h.

Referenced by File(), getLastSavedTimeStep(), read(), saveCurrentTimeStepNoFileTypeCheck(), setLastSavedTimeStep(), and write().

Mdouble File::logarithmicSaveCountBase_

private

the switch allow user to set saveCount in logarithmic timescale with equal distance , the number is the base of log scale from user input

Definition at line 282 of file File.h.

Referenced by File(), saveCurrentTimeStepNoFileTypeCheck(), and setlogarithmicSaveCount().

std::string File::name_

private

name of the file.

Definition at line 249 of file File.h.

Referenced by File(), getFullName(), getName(), read(), setName(), 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 270 of file File.h.

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

unsigned int File::saveCount_

private

Allows one to define the number of time steps 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 276 of file File.h.

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

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