Pscf::Rp::TrajectoryReader< D, T > Class Template Reference

Trajectory file reader (abstract base class). More...

#include <TrajectoryReader.h>

Public Member Functions
virtual void	open (std::string filename)=0
	Open trajectory file and allocate memory if necessary.
virtual void	readHeader ()
	Read header of trajectory file (if any).
virtual bool	readFrame ()=0
	Read a single frame.
virtual void	close ()=0
	Close the trajectory file.

Protected Member Functions
	TrajectoryReader (typename T::System &system)
	Constructor.
	~TrajectoryReader ()=default
	Destructor.
T::System &	system ()
	Return reference to parent system.

Detailed Description

template<int D, class T>
class Pscf::Rp::TrajectoryReader< D, T >

Trajectory file reader (abstract base class).

Specializations of this class template are used as base classes for two closely analogous class templates, also named TrajectoryReader, that are defined in Rpc and Rpg namespaces and used in the pscf_rpc and pscf_rpg programs, respectively.

Template parameters:

• D : dimension
• T : Types class, Rpc::Types<D> or Rpg::Types<D>

Definition at line 32 of file fts/trajectory/TrajectoryReader.h.

Constructor & Destructor Documentation

TrajectoryReader()

template<int D, class T>

Pscf::Rp::TrajectoryReader< D, T >::TrajectoryReader ( typename T::System & system )

inlineprotected

Constructor.

Parameters

system

parent System object

Definition at line 81 of file fts/trajectory/TrajectoryReader.h.

References system().

~TrajectoryReader()

template<int D, class T>

Pscf::Rp::TrajectoryReader< D, T >::~TrajectoryReader ( )

protecteddefault

Destructor.

Member Function Documentation

open()

template<int D, class T>

virtual void Pscf::Rp::TrajectoryReader< D, T >::open ( std::string filename )

pure virtual

Open trajectory file and allocate memory if necessary.

By convention, this function treats the trajectory filename as the name of an input file, and opens the file using the FileMaster:openInutFile function. This function prepends the input prefix (if any) to the file path.

Parameters

filename

trajectory input file name.

readHeader()

template<int D, class T>

virtual void Pscf::Rp::TrajectoryReader< D, T >::readHeader ( )

inlinevirtual

Read header of trajectory file (if any).

Empty default implementation.

Definition at line 56 of file fts/trajectory/TrajectoryReader.h.

readFrame()

template<int D, class T>

virtual bool Pscf::Rp::TrajectoryReader< D, T >::readFrame ( )

pure virtual

Read a single frame.

This function reads a frame from the trajectory file that was opened by the open() function.

Returns

true if a frame is avaiable, false if at end of file

close()

template<int D, class T>

virtual void Pscf::Rp::TrajectoryReader< D, T >::close ( )

pure virtual

Close the trajectory file.

system()

template<int D, class T>

T::System & Pscf::Rp::TrajectoryReader< D, T >::system ( )

inlineprotected

Return reference to parent system.

Definition at line 93 of file fts/trajectory/TrajectoryReader.h.

Referenced by TrajectoryReader().

---

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

• fts/trajectory/TrajectoryReader.h