Chaste  Release::3.4
OutputFileHandler.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef OUTPUTFILEHANDLER_HPP_
37 #define OUTPUTFILEHANDLER_HPP_
38 
39 #include <string>
40 #include <fstream>
41 #include <sstream>
42 #include <memory>
43 
44 class FileFinder; // Avoid circular includes
45 
47 typedef std::auto_ptr<std::ofstream> out_stream;
48 
55 {
56 public:
70  OutputFileHandler(const std::string& rDirectory,
71  bool cleanOutputDirectory = true);
72 
85  OutputFileHandler(const FileFinder& rDirectory,
86  bool cleanOutputDirectory = true);
87 
99  static std::string GetChasteTestOutputDirectory();
100 
105  std::string GetOutputDirectoryFullPath() const;
106 
110  std::string GetRelativePath() const;
111 
115  void SetArchiveDirectory() const;
116 
126  out_stream OpenOutputFile(const std::string& rFileName,
127  std::ios_base::openmode mode=std::ios::out | std::ios::trunc) const;
128 
142  out_stream OpenOutputFile(const std::string& rFileName,
143  unsigned number,
144  const std::string& rFileFormat,
145  std::ios_base::openmode mode=std::ios::out | std::ios::trunc) const;
146 
155  FileFinder CopyFileTo(const FileFinder& rSourceFile) const;
156 
162  FileFinder FindFile(std::string leafName) const;
163 
165  static const std::string SIG_FILE_NAME;
166 
167 private:
168 
169  std::string mDirectory;
170 
177  void CommonConstructor(const std::string& rDirectory,
178  bool cleanOutputDirectory);
179 
185  static void AddTrailingSlash(std::string& rDirectory);
186 
202  std::string MakeFoldersAndReturnFullPath(const std::string& rDirectory) const;
203 };
204 
205 #endif /*OUTPUTFILEHANDLER_HPP_*/
std::string MakeFoldersAndReturnFullPath(const std::string &rDirectory) const
static const std::string SIG_FILE_NAME
static void AddTrailingSlash(std::string &rDirectory)
FileFinder CopyFileTo(const FileFinder &rSourceFile) const
std::string GetOutputDirectoryFullPath() const
out_stream OpenOutputFile(const std::string &rFileName, std::ios_base::openmode mode=std::ios::out|std::ios::trunc) const
void SetArchiveDirectory() const
FileFinder FindFile(std::string leafName) const
std::string GetRelativePath() const
std::string mDirectory
The directory to store output files in (always ends in "/")
static std::string GetChasteTestOutputDirectory()
void CommonConstructor(const std::string &rDirectory, bool cleanOutputDirectory)
OutputFileHandler(const std::string &rDirectory, bool cleanOutputDirectory=true)