Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
File.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Andreas Bertsch, Chris Bielow, Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_SYSTEM_FILE_H
36 #define OPENMS_SYSTEM_FILE_H
37 
40 #include <OpenMS/config.h>
41 
42 
43 namespace OpenMS
44 {
45 
46  class TOPPBase;
47 
53  class OPENMS_DLLAPI File
54  {
55 public:
56 
57  friend class TOPPBase;
58 
63  static String getExecutablePath();
64 
66  static bool exists(const String& file);
67 
69  static bool empty(const String& file);
70 
76  static bool remove(const String& file);
77 
79  static bool removeDirRecursively(const String& dir_name);
80 
82  static bool removeDir(const QString& dir_name);
83 
85  static String absolutePath(const String& file);
86 
88  static String basename(const String& file);
89 
91  static String path(const String& file);
92 
100  static String removeExtension(const String& file);
101 
103  static bool readable(const String& file);
104 
106  static bool writable(const String& file);
107 
109  static bool isDirectory(const String& path);
110 
121  static String find(const String& filename, StringList directories = StringList());
122 
129  static bool fileList(const String& dir, const String& file_pattern, StringList& output, bool full_path = false);
130 
147  static String findDoc(const String& filename);
148 
155  static String getUniqueName(bool include_hostname = true);
156 
158  static String getOpenMSDataPath();
159 
161  static String getOpenMSHomePath();
162 
164  static String getTempDirectory();
165 
171  static String getUserDirectory();
172 
178  static Param getSystemParameters();
179 
183  static String findDatabase(const String& db_name);
184 
191  static String findExecutable(const String& toolName);
192 
209  static const String& getTemporaryFile(const String& alternative_file = "");
210 
211 private:
212 
214  static Param getSystemParameterDefaults_();
215 
217  static bool isOpenMSDataPath_(const String& path);
218 
219 
224  {
225  public:
226  TemporaryFiles_();
228  const String& newFile();
229 
230  ~TemporaryFiles_();
231  private:
232  TemporaryFiles_(const TemporaryFiles_&); // copy is forbidden
234  };
235 
236 
239 
240  };
241 
242 }
243 
244 #endif // OPENMS_SYSTEM_FILE_H
A more convenient string class.
Definition: String.h:57
StringList filenames_
Definition: File.h:233
static TemporaryFiles_ temporary_files_
private list of temporary filenames, which are deleted upon program exit
Definition: File.h:238
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Base class for TOPP applications.
Definition: TOPPBase.h:126
Internal helper class, which holds temporary filenames and deletes these file at program exit...
Definition: File.h:223
Basic file handling operations.
Definition: File.h:53
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Management and storage of parameters / INI files.
Definition: Param.h:75

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:00 using doxygen 1.8.13