OutputFileHandler.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 
00030 #ifndef OUTPUTFILEHANDLER_HPP_
00031 #define OUTPUTFILEHANDLER_HPP_
00032 
00033 #include <string>
00034 #include <fstream>
00035 #include <sstream>
00036 #include <memory>
00037 
00038 class FileFinder; // Avoid circular includes
00039 
00041 typedef std::auto_ptr<std::ofstream> out_stream;
00042 
00048 class OutputFileHandler
00049 {
00050 private:
00051     std::string mDirectory; 
00052 
00058     static void AddTrailingSlash(std::string& rDirectory);
00059 
00075     std::string MakeFoldersAndReturnFullPath(const std::string& rDirectory) const;
00076 
00077 public:
00091     OutputFileHandler(const std::string& rDirectory,
00092                       bool cleanOutputDirectory = true);
00093 
00105     static std::string GetChasteTestOutputDirectory();
00106 
00111     std::string GetOutputDirectoryFullPath() const;
00112 
00116     void SetArchiveDirectory() const;
00117 
00127     out_stream OpenOutputFile(const std::string& rFileName,
00128                               std::ios_base::openmode mode=std::ios::out | std::ios::trunc) const;
00129 
00130 
00143     out_stream OpenOutputFile(const std::string& rFileName,
00144                               unsigned number,
00145                               const std::string& rFileFormat,
00146                               std::ios_base::openmode mode=std::ios::out | std::ios::trunc) const;
00147 
00154     FileFinder CopyFileTo(const FileFinder& rSourceFile) const;
00155 
00161     FileFinder FindFile(std::string leafName) const;
00162 };
00163 
00164 #endif /*OUTPUTFILEHANDLER_HPP_*/

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5