IOManager.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//                - Lucas Teixeira, RHI Magnesita, 8700 Leoben, Autriche
//                  <lucas.teixeira@rhimagnesita.com>
//
// Copyright (C) 2008-2022 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff, L. Teixeira
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef _libCore_IOManager_hpp_
#define _libCore_IOManager_hpp_
 
 
#include <iostream>
#include <string>
#include <map>
#include <vector>
 
#include <boost/filesystem/path.hpp>
 
namespace fs = boost::filesystem;
 
//TODO define if the options will be passed at the creation of the problem or
//in the run method
//noNewDir and backupExecutableFile
namespace GranOO3
{
  namespace Core
  {
    
    class IOManager{
    public:
      static void fix_file_extension(std::string&, const std::string&);
      static bool check_file_extension(const std::string&, const std::string&);
      static void check_file_extension(std::string&, const std::string&, bool, bool);
      static void convert_to_absolute_path(fs::path& path);
      static void assert_file_exist(const fs::path&);
      static void assert_directory_exist(const fs::path&);
      
      
    public:
      IOManager();
 
      // Input related methods
      fs::path & get_input_file_path();
      const std::string & get_input_file_name();
      const std::string & get_input_file_content() const;
      const std::string & get_input_file_extension() const;
 
      void set_input_file_path(std::string);
      void set_input_file_substitution_pattern(const std::vector<std::string>&, const std::vector<std::string>&);
      void set_input_file_content(const std::string&);
      void apply_input_file_substitution_pattern();
      
      // Output related methods
      const fs::path & get_output_directory() const;
      void set_output_directory(std::string& path);
      void set_verbose(bool);
      const bool get_verbose() const;
      void set_backup_executable_file(bool);
      const bool get_backup_executable_file() const;
 
      // Backup related methods
      void make_backup(const std::string&);
      void set_no_new_dir(bool);
 
    private:
      void set_executable_filename(const std::string&);
      void create_backup_directory();
      void copy_input_file();
      void copy_executable();
      void assert_can_create_directory(const std::string&);
      
    private:
      // Input file related variables
      fs::path _inputFilePath;
      std::string _inputFileName;
      std::string _inputFileContent;
      std::map<std::string, std::string> _inputFileSubstitutionPattern;
      const std::string _inputFileExtension= ".inp";
      const std::string _backupDirName = "backup";
 
      // Output file related variables
      std::ofstream* _outputFile;
      fs::path _outputFilePath;
      fs::path _outputDirectory;
      bool _noNewDir;
      bool _backupExecutableFile;
      bool _verbose;
 
      // Backup related variables
      fs::path _executable;
      fs::path _backUpDirectory;
      std::vector<fs::path> _sampleFiles;
 
    };
 
    inline fs::path&
    IOManager::get_input_file_path(){
      return _inputFilePath;
    }
 
    inline const std::string&
    IOManager::get_input_file_name(){
      return _inputFilePath.string();
    }
 
    inline const std::string&
    IOManager::get_input_file_extension() const{
      return _inputFileExtension;
    }
 
    inline const std::string&
    IOManager::get_input_file_content() const{
      return _inputFileContent;
    }
 
    inline const fs::path&
    IOManager::get_output_directory() const{
      return _outputDirectory;
    }
 
    inline const bool IOManager::get_verbose() const{
      return _verbose;
    }
 
    inline const bool
    IOManager::get_backup_executable_file() const{
      return _backupExecutableFile;
    }
  }
}
 
 
 
#endif