trajectoryFile.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: trajectoryFile.h,v 1.21.18.1 2007/03/25 21:23:42 oliver Exp $
//

#ifndef BALL_FORMAT_TRAJECTORYFILE_H
#define BALL_FORMAT_TRAJECTORYFILE_H

#ifndef BALL_SYSTEM_FILE_H
# include <BALL/SYSTEM/file.h>
#endif

#ifndef BALL_MOLMEC_COMMON_SNAPSHOT_H
# include <BALL/MOLMEC/COMMON/snapShot.h>
#endif

namespace BALL
{
  class SnapShot;
  class SnapShotManager;

  class BALL_EXPORT TrajectoryFile
    : public File
  {

    public:



    TrajectoryFile()
      ;

    TrajectoryFile(const TrajectoryFile& file)
      ;

    TrajectoryFile(const String& filename,
      File::OpenMode open_mode = std::ios::in)
      throw(Exception::FileNotFound);

    virtual ~TrajectoryFile()
      ;



    
    const TrajectoryFile& operator = (const TrajectoryFile& file)
      ;

    virtual void clear()
      ;




    bool operator == (const TrajectoryFile& file) const
      ;




    Size getNumberOfSnapShots() const
      ;

    Size getNumberOfAtoms() const
      ;




    virtual bool readHeader()
      ;

    virtual bool writeHeader()
      ;

    virtual bool append(const SnapShot& snapshot)
      ;

    virtual bool read(SnapShot& snapshot)
      ;

    virtual bool flushToDisk(const std::vector<SnapShot>& buffer)
      throw(File::CannotWrite);

    protected:

    //_ @name Protected Members

    //_ The number of snapshots stored in that file
    Size number_of_snapshots_;
    
    //_ The number of atoms covered by the snapshots
    Size number_of_atoms_;
    
    
  };
} // namespace BALL

#endif //  BALL_FORMAT_TRAJECTORYFILE_H