Basic file handling operations. More...
#include <OpenMS/SYSTEM/File.h>
Static Public Member Functions | |
static String | getExecutablePath () |
static bool | exists (const String &file) |
Method used to test if a file exists. More... | |
static bool | empty (const String &file) |
Return true if the file does not exist or the file is empty. More... | |
static bool | remove (const String &file) |
Removes a file (if it exists). More... | |
static bool | removeDirRecursively (const String &dir_name) |
Removes the specified directory (absolute path). Returns true if successful. More... | |
static String | absolutePath (const String &file) |
Replaces the relative path in the argument with the absolute path. More... | |
static String | basename (const String &file) |
Returns the basename of the file (without the path). More... | |
static String | path (const String &file) |
Returns the path of the file (without the file name). More... | |
static String | removeExtension (const String &file) |
static bool | readable (const String &file) |
Return true if the file exists and is readable. More... | |
static bool | writable (const String &file) |
Return true if the file is writable. More... | |
static bool | isDirectory (const String &path) |
Return true if the given path specifies a directory. More... | |
static String | find (const String &filename, StringList directories=StringList()) |
Looks up the location of the file filename . More... | |
static bool | fileList (const String &dir, const String &file_pattern, StringList &output, bool full_path=false) |
Retrieves a list of files matching file_pattern in directory dir (returns filenames without paths unless full_path is true) More... | |
static String | findDoc (const String &filename) |
Resolves a partial file name to a documentation file in the doc-folder. More... | |
static String | getUniqueName () |
Returns a string, consisting of date, time, hostname, process id, and a incrementing number. This can be used for temporary files. More... | |
static String | getOpenMSDataPath () |
Returns the OpenMS data path (environment variable overwrites the default installation path) More... | |
static String | getTempDirectory () |
The current OpenMS temporary data path (for temporary files) More... | |
static String | getUserDirectory () |
The current OpenMS user data path (for result files) More... | |
static Param | getSystemParameters () |
static String | findDatabase (const String &db_name) |
static String | findExecutable (const String &toolName) |
Searches for an executable with the given name. More... | |
Static Private Member Functions | |
static Param | getSystemParameterDefaults_ () |
get defaults for the system's Temp-path, user home directory etc. More... | |
static bool | isOpenMSDataPath_ (const String &path) |
Check if the given path is a valid OPENMS_DATA_PATH. More... | |
Friends | |
class | TOPPBase |
Basic file handling operations.
Replaces the relative path in the argument with the absolute path.
Referenced by TOPPViewBase::addDataFile(), and TOPPViewBase::addRecentFile_().
Returns the basename of the file (without the path).
Referenced by TOPPViewBase::addDataFile(), TOPPASBase::addTOPPASFile(), DTAFile::load(), FileHandler::loadExperiment(), TOPPASBase::refreshParameters(), AccurateMassSearchEngine::resolveAutoMode_(), TOPPASBase::saveCurrentPipelineAs(), TOPPASBase::savePipeline(), TOPPASBase::savePipelineAs(), and INIFileEditorWindow::updateWindowTitle().
Return true if the file does not exist or the file is empty.
Method used to test if a file
exists.
Referenced by TOPPViewBase::addDataFile(), MS2File::load(), MascotInfile::load(), MascotGenericFile::load(), TOPPASBase::loadPreferences(), TOPPViewBase::loadPreferences(), and TOPPASBase::openFilesInTOPPView().
|
static |
Retrieves a list of files matching file_pattern
in directory dir
(returns filenames without paths unless full_path
is true)
|
static |
Looks up the location of the file filename
.
The following locations are checked in this order:
directories
FileNotFound | is thrown, if the file is not found |
Referenced by MzMLHandler< MSExperiment<> >::MzMLHandler().
uses File::find() to search for a file names db_name
in the 'id_db_dir' param of the OpenMS system parameters
FileNotFound | is thrown, if the file is not found |
Resolves a partial file name to a documentation file in the doc-folder.
Using find() to locate the documentation file under OPENMS_DATA_PATH, OPENMS_SOURCE_PATH, OPENMS_BINARY_PATH + "/../../doc" (or a variation for MacOS packages)
Will return the String with the full path to the local documentation. If this call fails, try the web documentation (http://www.openms.de/current_doxygen/) instead.
String | The doc file name to find. |
FileNotFound | is thrown, if the file is not found |
Referenced by TOPPASBase::showURL(), and TOPPViewBase::showURL().
Searches for an executable with the given name.
toolName | The executable to search for. |
FileNotFound | is thrown, if the tool executable was not found. |
Referenced by TOPPASBase::openFilesInTOPPView(), and TOPPViewBase::runTOPPTool_().
|
static |
Retrieve path of current executable (useful to find other TOPP tools) The returned path is either just an EMPTY string if the call to system subroutines failed or the complete path including a trailing "/", to enable usage of this function as File::getExecutablePath() + "mytool"
Referenced by TOPPASBase::openFilesInTOPPView().
|
static |
Returns the OpenMS data path (environment variable overwrites the default installation path)
Referenced by TOPPASBase::openExampleDialog(), and TOPPViewBase::openExampleDialog().
|
staticprivate |
get defaults for the system's Temp-path, user home directory etc.
|
static |
get the system's default OpenMS.ini file in the users home directory (<home>/OpenMS/OpenMS.ini) or create/repair it if required
|
static |
The current OpenMS temporary data path (for temporary files)
Referenced by TOPPASBase::TOPPASBase(), and TOPPASBase::~TOPPASBase().
|
static |
Returns a string, consisting of date, time, hostname, process id, and a incrementing number. This can be used for temporary files.
Referenced by TOPPViewBase::showTOPPDialog_(), and TOPPASBase::TOPPASBase().
Return true if the given path specifies a directory.
Check if the given path is a valid OPENMS_DATA_PATH.
Returns the path of the file (without the file name).
Referenced by FileHandler::loadExperiment(), TOPPViewBase::updateCurrentPath(), and INIFileEditorWindow::updateWindowTitle().
Return true if the file exists and is readable.
Referenced by TOPPViewBase::finishTOPPToolExecution(), MS2File::load(), and INIFileEditorWindow::openFile().
Removes a file (if it exists).
Referenced by TOPPViewBase::finishTOPPToolExecution(), and TOPPViewBase::rerunTOPPTool().
Removes the specified directory (absolute path). Returns true if successful.
Referenced by TOPPASBase::~TOPPASBase().
Returns the file name without the extension
The extension is the suffix of the string up to and including the last dot.
If no extension is found, the whole file name is returned
Return true if the file is writable.
Referenced by TOPPViewBase::runTOPPTool_(), and TOPPViewBase::showTOPPDialog_().
|
friend |
OpenMS / TOPP release 2.0.0 | Documentation generated on Fri May 29 2015 17:20:38 using doxygen 1.8.9.1 |