Main MRPT website > C++ reference for MRPT 1.5.7
Functions
Directories, files, and file names (in #include <mrpt/system/filesystem.h>)

Detailed Description

Collaboration diagram for Directories, files, and file names (in #include <mrpt/system/filesystem.h>):

Functions

std::string BASE_IMPEXP mrpt::system::getTempFileName ()
 Returns the name of a proposed temporary file name. More...
 
std::string BASE_IMPEXP mrpt::system::getcwd ()
 Returns the current working directory. More...
 
std::string BASE_IMPEXP mrpt::system::getShareMRPTDir ()
 Attempts to find the directory [PREFIX/]share/mrpt/ and returns its absolute path, or empty string if not found. More...
 
bool BASE_IMPEXP mrpt::system::createDirectory (const std::string &dirName)
 Creates a directory. More...
 
bool BASE_IMPEXP mrpt::system::deleteFile (const std::string &fileName)
 Deletes a single file. More...
 
void BASE_IMPEXP mrpt::system::deleteFiles (const std::string &s)
 Delete one or more files, especified by the (optional) path and the file name (including '?' or '*') - Use forward slash ('/') for directories for compatibility between Windows and Linux, since they will be internally traslated into backward slashes ('\') if MRPT is compiled under Windows. More...
 
bool BASE_IMPEXP mrpt::system::renameFile (const std::string &oldFileName, const std::string &newFileName, std::string *error_msg=NULL)
 Renames a file - If the target path is different and the filesystem allows it, it will be moved to the new location. More...
 
bool BASE_IMPEXP mrpt::system::deleteFilesInDirectory (const std::string &s, bool deleteDirectoryAsWell=false)
 Delete all the files in a given directory (nothing done if directory does not exists, or path is a file). More...
 
std::string BASE_IMPEXP mrpt::system::extractFileName (const std::string &filePath)
 Extract just the name (without extension) of a filename from a complete path plus name plus extension. More...
 
std::string BASE_IMPEXP mrpt::system::extractFileExtension (const std::string &filePath, bool ignore_gz=false)
 Extract the extension of a filename. More...
 
std::string BASE_IMPEXP mrpt::system::extractFileDirectory (const std::string &filePath)
 Extract the whole path (the directory) of a filename from a complete path plus name plus extension. More...
 
bool BASE_IMPEXP mrpt::system::fileExists (const std::string &fileName)
 Test if a given file (or directory) exists. More...
 
bool BASE_IMPEXP mrpt::system::directoryExists (const std::string &fileName)
 Test if a given directory exists (it fails if the given path refers to an existing file). More...
 
std::string BASE_IMPEXP mrpt::system::fileNameStripInvalidChars (const std::string &filename, const char replacement_to_invalid_chars= '_')
 Replace invalid filename chars by underscores ('_') or any other user-given char. More...
 
std::string BASE_IMPEXP mrpt::system::fileNameChangeExtension (const std::string &filename, const std::string &newExtension)
 Replace the filename extension by another one. More...
 
uint64_t BASE_IMPEXP mrpt::system::getFileSize (const std::string &fileName)
 Return the size of the given file, or size_t(-1) if some error is found accessing that file. More...
 
time_t BASE_IMPEXP mrpt::system::getFileModificationTime (const std::string &filename)
 Return the time of the file last modification, or "0" if the file doesn't exist. More...
 
std::string BASE_IMPEXP mrpt::system::filePathSeparatorsToNative (const std::string &filePath)
 Windows: replace all '/'->'\' , in Linux/MacOS: replace all '\'->'/'. More...
 
bool BASE_IMPEXP mrpt::system::copyFile (const std::string &sourceFile, const std::string &targetFile, std::string *outErrStr=NULL, bool copyAttribs=true)
 Copies file sourceFile to targetFile. More...
 

Function Documentation

bool mrpt::system::copyFile ( const std::string sourceFile,
const std::string targetFile,
std::string outErrStr = NULL,
bool  copyAttribs = true 
)

Copies file sourceFile to targetFile.

If the target file exists, it will be overwritten. If the target file cannot be overwritten, the function first tries to change its permissions/attributes and retries opening it for write.

Note
Only for Windows: After a successful copy, if copyAttribs is true, the attributes of the source file are also copied. Note that not all attributes can be copied: http://msdn2.microsoft.com/en-us/library/aa365535.aspx
Returns
true on success, false on any error, whose description can be optionally get in outErrStr

Definition at line 374 of file filesystem.cpp.

References mrpt::system::directoryExists(), mrpt::system::os::fclose(), mrpt::system::fileExists(), mrpt::system::filePathSeparatorsToNative(), and mrpt::system::os::fopen().

bool mrpt::system::createDirectory ( const std::string dirName)
bool mrpt::system::deleteFile ( const std::string fileName)
void mrpt::system::deleteFiles ( const std::string s)

Delete one or more files, especified by the (optional) path and the file name (including '?' or '*') - Use forward slash ('/') for directories for compatibility between Windows and Linux, since they will be internally traslated into backward slashes ('\') if MRPT is compiled under Windows.

See also
deleteFile

Definition at line 183 of file filesystem.cpp.

References MRPT_END, MRPT_START, mrpt::system::os::sprintf(), and mrpt::system::os::strcat().

bool mrpt::system::deleteFilesInDirectory ( const std::string s,
bool  deleteDirectoryAsWell = false 
)

Delete all the files in a given directory (nothing done if directory does not exists, or path is a file).

See also
deleteFile
Returns
true on success

Definition at line 209 of file filesystem.cpp.

References _rmdir, mrpt::system::deleteFile(), mrpt::system::directoryExists(), FILE_ATTRIB_ARCHIVE, and FILE_ATTRIB_DIRECTORY.

Referenced by mrpt::slam::CGridMapAligner::AlignPDF_robustMatch(), mrpt::hmtslam::CHMTSLAM::initializeEmptyMap(), and CGraphSlamHandler< GRAPH_T >::initOutputDir().

bool mrpt::system::directoryExists ( const std::string fileName)
string mrpt::system::extractFileDirectory ( const std::string filePath)
string mrpt::system::extractFileExtension ( const std::string filePath,
bool  ignore_gz = false 
)

Extract the extension of a filename.

For example, for "dummy.cpp", it will return "cpp". If "ignore_gz" is true, the second extension will be returned if the file name ends in ".gz", for example, for "foo.map.gz", this will return "map".

See also
extractFileName,extractFileDirectory

Definition at line 96 of file filesystem.cpp.

References int().

Referenced by mrpt::vision::checkerBoardCameraCalibration(), mrpt::system::CDirectoryExplorer::filterByExtension(), mrpt::obs::CObservation3DRangeScan::load(), mrpt::opengl::C3DSScene::loadFrom3DSFile(), run_test_pf_localization(), TEST(), and mrpt::opengl::CAssimpModel::traceRay().

string mrpt::system::extractFileName ( const std::string filePath)
bool mrpt::system::fileExists ( const std::string fileName)
std::string mrpt::system::fileNameChangeExtension ( const std::string filePath,
const std::string newExtension 
)

Replace the filename extension by another one.

Example:

fileNameChangeExtension("cool.txt","bar") // -> "cool.bar"

Definition at line 356 of file filesystem.cpp.

Referenced by mrpt::obs::CObservation3DRangeScan::points3D_convertToExternalStorage(), mrpt::obs::CObservation3DRangeScan::rangeImage_convertToExternalStorage(), and TEST().

std::string mrpt::system::fileNameStripInvalidChars ( const std::string filename,
const char  replacement_to_invalid_chars = '_' 
)
std::string mrpt::system::filePathSeparatorsToNative ( const std::string filePath)

Windows: replace all '/'->'\' , in Linux/MacOS: replace all '\'->'/'.

Definition at line 543 of file filesystem.cpp.

Referenced by mrpt::system::copyFile(), TEST(), and mrpt::opengl::CAssimpModel::traceRay().

std::string mrpt::system::getcwd ( )

Returns the current working directory.

Definition at line 239 of file filesystem.cpp.

References MRPT_END, MRPT_START, and THROW_EXCEPTION.

time_t mrpt::system::getFileModificationTime ( const std::string filename)

Return the time of the file last modification, or "0" if the file doesn't exist.

Definition at line 558 of file filesystem.cpp.

uint64_t mrpt::system::getFileSize ( const std::string fileName)

Return the size of the given file, or size_t(-1) if some error is found accessing that file.

Definition at line 338 of file filesystem.cpp.

Referenced by mrpt::utils::CFileGZInputStream::open().

std::string mrpt::system::getShareMRPTDir ( )

Attempts to find the directory [PREFIX/]share/mrpt/ and returns its absolute path, or empty string if not found.

Example return paths: Linux after installing = /usr/share/mrpt/; manually-built system = [CMAKE_SOURCE_DIR]/share/mrpt/, etc.

Definition at line 567 of file filesystem.cpp.

References mrpt::system::directoryExists(), and mrpt::system::extractFileDirectory().

std::string mrpt::system::getTempFileName ( )
bool mrpt::system::renameFile ( const std::string oldFileName,
const std::string newFileName,
std::string error_msg = NULL 
)

Renames a file - If the target path is different and the filesystem allows it, it will be moved to the new location.

Returns
false on any error. In that case, if a pointer to a receiver string is passed in error_msg, a description of the error is saved there.

Definition at line 297 of file filesystem.cpp.

Referenced by CGraphSlamHandler< GRAPH_T >::initOutputDir().




Page generated by Doxygen 1.8.11 for MRPT 1.5.7 Git: 2190203 Tue May 15 02:01:15 2018 +0200 at miƩ may 16 12:40:16 CEST 2018