---

colvarproxy_io.h

Go to the documentation of this file.

// -*- c++ -*-

// This file is part of the Collective Variables module (Colvars).
// The original version of Colvars and its updates are located at:
// https://github.com/Colvars/colvars
// Please update all Colvars source files before making any changes.
// If you wish to distribute your changes, please submit them to the
// Colvars repository at GitHub.

#ifndef COLVARPROXY_IO_H
#define COLVARPROXY_IO_H

#include <map>
#include <string>
#include <iosfwd>


class colvarproxy_io {

public:

  colvarproxy_io();

  virtual ~colvarproxy_io();

  virtual bool io_available();

  // Returns error code
  virtual int get_frame(long int &);

  // Returns error code
  virtual int set_frame(long int);

  virtual int backup_file(char const *filename);

  inline int backup_file(std::string const &filename)
  {
    return backup_file(filename.c_str());
  }

  virtual int remove_file(char const *filename);

  inline int remove_file(std::string const &filename)
  {
    return remove_file(filename.c_str());
  }

  virtual int rename_file(char const *filename, char const *newfilename);

  inline int rename_file(std::string const &filename,
                         std::string const &newfilename)
  {
    return rename_file(filename.c_str(), newfilename.c_str());
  }

  inline std::string & input_prefix()
  {
    return input_prefix_str;
  }

  inline std::string & output_prefix()
  {
    return output_prefix_str;
  }

  inline std::string & restart_output_prefix()
  {
    return restart_output_prefix_str;
  }

  inline int default_restart_frequency() const
  {
    return restart_frequency_engine;
  }

  inline char const * & input_buffer()
  {
    return input_buffer_;
  }

  virtual std::istream &input_stream(std::string const &input_name,
                                     std::string const description = "file/channel",
                                     bool error_on_fail = true);

  virtual bool input_stream_exists(std::string const &input_name);

  virtual int close_input_stream(std::string const &input_name);

  virtual int close_input_streams();

  virtual std::ostream &output_stream(std::string const &output_name,
                                      std::string const description = "file/channel");

  virtual bool output_stream_exists(std::string const &output_name);

  virtual int flush_output_stream(std::string const &output_name);

  virtual int flush_output_streams();

  virtual int close_output_stream(std::string const &output_name);

  virtual int close_output_streams();

protected:

  std::string input_prefix_str;

  std::string output_prefix_str;

  std::string restart_output_prefix_str;

  int restart_frequency_engine;

  std::map<std::string, std::istream *> input_streams_;

  std::istream *input_stream_error_;

  std::map<std::string, std::ostream *> output_streams_;

  std::ostream *output_stream_error_;

  char const *input_buffer_;
};


#endif

---