DataReader::DataFile Class Reference

Base class for reading and storing simulation output. More...

#include <DataFile.h>

Inheritance diagram for DataReader::DataFile:

Public Types
enum	EFileType { RPK, Snapshot, Savepoint, CollisionEnergy }
	Lists the type of data the files are storing. More...

Public Member Functions
	DataFile (const string &fileName="")
	Constructor. More...
virtual void	Read (const string &fileName)=0
	Parses a file according to the implementation of a derived file reader.
string	GetFileName () const
	Returns the name of the file the data was read from.
EFileType	GetType () const
	Returns the type of data stored.
bool	GetDataStored () const
	Returns whether or not data has been stored.

Static Public Attributes
static const char *	Delimiters = " ,\n"
	List of delimiters that are used in files.

Protected Attributes
string	FileName_
	Name of the file that the data is read from.
EFileType	Type_
	Indicates the type of data stored.
bool	DataStored_
	Flag indicating if data has been stored.

Detailed Description

Base class for reading and storing simulation output.

DataFile provides a simple interface for implementing file parsers for different classes of files that are generated by the MD simulation. This base class includes items that are common to all file parsers: a file name, a read method, a read status, and a discernible file type. Get accessors for these items are also predefined in this class.

Member Enumeration Documentation

enum DataReader::DataFile::EFileType

Lists the type of data the files are storing.

Enumerator
RPK	Rayleigh-Plesset predicted trend of the simulation.
Snapshot	Periodic snapshot, in the form of metadata, of the MD simulation.
Savepoint	Record of the position, velocity, and type of each particle in the system.
CollisionEnergy	Record of the collision information of each particle in the system.

Constructor & Destructor Documentation

DataReader::DataFile::DataFile ( const string &  fileName = "" )

inline

Constructor.

Initializes the file name and read status.

Parameters

fileName

is the name of the file whose data we are looking to store.

---

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

• DataReader/DataFile.h
• DataReader/DataFile.cpp