Directories, files, and file names

Collaboration diagram for Directories, files, and file names:

Functions
std::string BASE_IMPEXP	mrpt::system::getTempFileName ()
	Returns the name of a proposed temporary file name.
std::string BASE_IMPEXP	mrpt::system::getcwd ()
	Returns the current working directory.
bool BASE_IMPEXP	mrpt::system::createDirectory (const std::string &dirName)
	Creates a directory.
bool BASE_IMPEXP	mrpt::system::deleteFile (const std::string &fileName)
	Deletes a single file.
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.
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.
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).
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.
std::string BASE_IMPEXP	mrpt::system::extractFileExtension (const std::string &filePath, bool ignore_gz=false)
	Extract the extension of a filename.
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.
bool BASE_IMPEXP	mrpt::system::fileExists (const std::string &fileName)
	Test if a given file (or directory) exists.
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).
std::string BASE_IMPEXP	mrpt::system::fileNameStripInvalidChars (const std::string &filename)
	Replace invalid filename chars by underscores ('_').
std::string BASE_IMPEXP	mrpt::system::fileNameChangeExtension (const std::string &filename, const std::string &newExtension)
	Replace the filename extension by another one.
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.

---

Function Documentation

bool BASE_IMPEXP mrpt::system::createDirectory

(

const std::string &

dirName

)

Creates a directory.

Returns:

Returns false on any error, true on everything OK.

Todo:

Seems to return false on Linux even after creating the directory OK.

bool BASE_IMPEXP mrpt::system::deleteFile

(

const std::string &

fileName

)

Deletes a single file.

For multiple files see deleteFiles

Returns:

Returns false on any error, true on everything OK.

See also:

deleteFiles

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.

See also:

deleteFile

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).

See also:

deleteFile

Returns:

true on success

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).

See also:

fileExists

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.

This function works for either "/" or "\" directory separators.

See also:

extractFileName,extractFileExtension

std::string BASE_IMPEXP 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

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.

This function works for either "/" or "\" directory separators.

See also:

extractFileExtension,extractFileDirectory

bool BASE_IMPEXP mrpt::system::fileExists

(

const std::string &

fileName

)

Test if a given file (or directory) exists.

See also:

directoryExists

std::string BASE_IMPEXP mrpt::system::fileNameChangeExtension	(	const std::string &	filename,
		const std::string &	newExtension
	)

Replace the filename extension by another one.

Example:

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

std::string BASE_IMPEXP mrpt::system::fileNameStripInvalidChars

(

const std::string &

filename

)

Replace invalid filename chars by underscores ('_').

Invalid chars are identified by those not being alphanumeric or: ".-#%$&()+[]{}"

std::string BASE_IMPEXP mrpt::system::getcwd

(

)

Returns the current working directory.

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.

std::string BASE_IMPEXP mrpt::system::getTempFileName

(

)

Returns the name of a proposed temporary file name.

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.

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.