Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
OutputFileHandler.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF 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 <fstream>
40#include <ios>
41#include <memory>
42#include <string>
43
44class FileFinder; // Avoid circular includes
45
47typedef std::shared_ptr<std::ofstream> out_stream;
48
55{
56public:
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
167private:
168 std::string mDirectory;
169
176 void CommonConstructor(const std::string& rDirectory,
177 bool cleanOutputDirectory);
178
184 static void AddTrailingSlash(std::string& rDirectory);
185
201 std::string MakeFoldersAndReturnFullPath(const std::string& rDirectory) const;
202};
203
204#endif /*OUTPUTFILEHANDLER_HPP_*/
FileFinder CopyFileTo(const FileFinder &rSourceFile) const
static void AddTrailingSlash(std::string &rDirectory)
static std::string GetChasteTestOutputDirectory()
static const std::string SIG_FILE_NAME
std::string GetOutputDirectoryFullPath() const
void SetArchiveDirectory() const
FileFinder FindFile(std::string leafName) const
std::string MakeFoldersAndReturnFullPath(const std::string &rDirectory) const
out_stream OpenOutputFile(const std::string &rFileName, std::ios_base::openmode mode=std::ios::out|std::ios::trunc) const
void CommonConstructor(const std::string &rDirectory, bool cleanOutputDirectory)
std::string mDirectory
The directory to store output files in (always ends in "/")
std::string GetRelativePath() const