Chemical Data Processing Library C++ API - Version 1.4.0
FileRemover.hpp
Go to the documentation of this file.
1 /*
2  * FileRemover.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_UTIL_FILEREMOVER_HPP
30 #define CDPL_UTIL_FILEREMOVER_HPP
31 
32 #include <string>
33 
34 #include "CDPL/Util/APIPrefix.hpp"
35 
36 
37 namespace CDPL
38 {
39 
40  namespace Util
41  {
42 
48  {
49 
50  public:
55  FileRemover(const std::string& path):
56  path(path) {}
57 
62 
67  const std::string& getPath() const;
68 
73  void reset(const std::string& new_path);
74 
78  void release();
79 
86 
87  private:
88  void removeFile();
89 
90  std::string path;
91  };
92  } // namespace Util
93 } // namespace CDPL
94 
95 #endif // CDPL_UTIL_FILEREMOVER_HPP
Definition of the preprocessor macro CDPL_UTIL_API.
#define CDPL_UTIL_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
RAII helper that deletes a file when the FileRemover instance goes out of scope (unless released befo...
Definition: FileRemover.hpp:48
void reset(const std::string &new_path)
Replaces the currently held path with new_path; the previously held file is removed immediately.
void release()
Releases the FileRemover from its current path so that the file will not be removed on destruction.
const std::string & getPath() const
Returns the file-system path currently guarded by the FileRemover.
~FileRemover()
Destructor. Removes the file at the currently held path unless release() has been called.
FileRemover & operator=(FileRemover &rhs)
Move-style assignment: takes over the path held by rhs and releases rhs.
FileRemover(const std::string &path)
Constructs a FileRemover guarding the file at path.
Definition: FileRemover.hpp:55
The namespace of the Chemical Data Processing Library.