colvarproxy_io.h

// -*- 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 <iosfwd>
#include <list>
#include <map>
#include <string>
 
 
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 const & input_prefix() const
  {
    return input_prefix_str;
  }
 
  virtual int set_input_prefix(std::string const &prefix);
 
  inline std::string const & output_prefix() const
  {
    return output_prefix_str;
  }
 
  virtual int set_output_prefix(std::string const &prefix);
 
  inline std::string const & restart_output_prefix() const
  {
    return restart_output_prefix_str;
  }
 
  virtual int set_restart_output_prefix(std::string const &prefix);
 
  inline int default_restart_frequency() const
  {
    return restart_frequency_engine;
  }
 
  virtual int set_default_restart_frequency(int freq);
 
  // The input stream functions below are not virtual, because they currently
  // rely on the fact that either std::ifstream or std::istringstream is used
 
  std::istream & input_stream(std::string const &input_name,
                              std::string const description = "file/channel",
                              bool error_on_fail = true);
 
  std::istream & input_stream_from_string(std::string const &input_name,
                                          std::string const &content,
                                          std::string const description = "string");
 
  bool input_stream_exists(std::string const &input_name);
 
  int close_input_stream(std::string const &input_name);
 
  int close_input_streams();
 
  int delete_input_stream(std::string const &input_name);
 
  std::list<std::string> list_input_stream_names() const;
 
  virtual std::ostream &output_stream(std::string const &output_name,
                                      std::string const description);
 
  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_;
};
 
 
#endif