FileMaster.h

#ifndef UTIL_FILE_MASTER_H
#define UTIL_FILE_MASTER_H

/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/

#include <util/param/ParamComposite.h>      // base class

#include <ios>
#include <fstream>
#include <string>

namespace Util
{

   class FileMaster : public ParamComposite
   {
   
   public:

      FileMaster();
 
      FileMaster(const FileMaster& copy);
 
      virtual ~FileMaster();



      void setRootPrefix(const std::string& rootPrefix);

      void setDirectoryId(int directoryId);

      void setCommonControl();

      void setParamFileName(const std::string& paramFileName);

      void setCommandFileName(const std::string& commandFileName);

      void setInputPrefix(const std::string& inputPrefix);
 
      void setOutputPrefix(const std::string& outputPrefix);
 
      virtual void readParameters(std::istream& in);



      virtual void loadParameters(Serializable::IArchive &ar);
   
      virtual void save(Serializable::OArchive &ar);
   

      
      void open(const std::string& name, std::ifstream& in, 
                std::ios_base::openmode mode = std::ios_base::in) const;

      void open(const std::string& name, std::ofstream& out, 
                std::ios_base::openmode mode = std::ios_base::out) const;

      void openControlFile(const std::string& name, 
                           std::ifstream& in) const;

      void 
      openRestartIFile(const std::string& name, std::ifstream& in,
                       std::ios_base::openmode mode = std::ios_base::in) 
      const;

      void 
      openRestartOFile(const std::string& name, std::ofstream& out,
                       std::ios_base::openmode mode = std::ios_base::out) 
      const;

      void 
      openInputFile(const std::string& filename, std::ifstream& in, 
                    std::ios_base::openmode mode = std::ios_base::in) 
      const;

      void 
      openOutputFile(const std::string& filename, std::ofstream& out, 
                     std::ios_base::openmode mode = std::ios_base::out) 
      const;


      
      bool isCommonControl() const;

      std::string paramFileName() const;

      std::string commandFileName() const;

      std::istream& paramFile();

      std::istream& commandFile();

      
   private:

      /*
      * Name of the parameter file.
      */
      std::string  paramFileName_;

      /*
      * Name of the command file.
      */
      std::string  commandFileName_;

      /*
      * Prefix for input data file names.
      */
      std::string  inputPrefix_;

      /*
      * Prefix for output data file names.
      */
      std::string  outputPrefix_;

      /*
      * The integer directory id prefix, for multi-system simulations.
      */
      std::string  directoryIdPrefix_;

      /*
      * Path for the root directory of files for this simulation.
      */
      std::string  rootPrefix_;

      /*
      * Pointer to the parameter file.
      */
      std::ifstream*  paramFilePtr_;

      /*
      * Pointer to the command file.
      */
      std::ifstream*  commandFilePtr_;

      /*
      * Has a directoryId prefix been set?
      */
      bool  hasDirectoryId_;

      /*
      * Should we use a single parameter and command file?
      */
      bool isCommonControl_;

   };

   /*
   * Return the command file base name.
   */
   inline std::string FileMaster::paramFileName() const
   {  return paramFileName_; }

   /*
   * Return the command file base name.
   */
   inline std::string FileMaster::commandFileName() const
   {  return commandFileName_; }

} 
#endif