A class for handling system files and paths using UTF-8 strings. More...

#include <FileSystem.h>

Static Public Member Functions
static std::string	absolutePath (const std::string &path)
	Retrives the absolute path for the given path in UTF-8. More...

static void	copyFile (const std::string &from, const std::string &to)
	Copies a file. More...

static bool	createDirectories (const std::string &path)
	Creates a directory for any element of path that does not exist. More...

static bool	createDirectory (const std::string &path)
	Creates a directory from a given path in UTF-8. More...

static std::string	currentPath ()
	Retrives the current working directory path in UTF-8. More...

static std::string	executableDirectory ()

static bool	exists (const std::string &path)
	Checks if a given path in UTF-8 exists. More...

static std::string	extension (const std::string &path)
	Retrives the extension of a given file path in UTF-8. More...

static std::string	fileName (const std::string &path)
	Retrives the filename of a given file path in UTF-8, including extension. More...

static uintmax_t	fileSize (const std::string &path)
	Returns the file size of a FILE in UTF-8. More...

static bool	isDirectory (const std::string &path)
	Checks if a given path in UTF-8 is a directory. More...

static bool	isEmpty (const std::string &path)
	Checks if a given path in UTF-8 is an empty directory. More...

static bool	isRegularFile (const std::string &path)
	Checks if a given path in UTF-8 is a regular file. More...

static std::vector< std::string >	listDirectory (const std::string &path)
	Lists a directory from a given path in UTF-8. More...

static std::string	parentPath (const std::string &path)
	Retrives the parent path of a given file path in UTF-8. For /home/files/fileName.shp, it will return /home/files. More...

static bool	remove (const std::string &path)
	Removes a file or directory from a given path in UTF-8. More...

static void	rename (const std::string &old_p, const std::string &new_p)
	Renames a file or directory from a given path in UTF-8. More...

static std::string	stem (const std::string &path)
	Retrives the filename of a given file path in UTF-8, excluding extension. More...

static std::string	systemCompletePath (const std::string &path)
	Composes an absolute path for the given path in UTF-8. More...

static std::string	tempDirectoryPath ()
	Retrives the temp directory in UTF-8. More...

static std::string	uniquePath (const std::string &format="%%%%-%%%%-%%%%-%%%%")
	Retrives an unique path generated by a given format. More...

Private Member Functions
	FileSystem ()

	FileSystem (FileSystem const &)

FileSystem &	operator= (FileSystem const &)

	~FileSystem ()

Detailed Description

A class for handling system files and paths using UTF-8 strings.

Definition at line 50 of file FileSystem.h.

Constructor & Destructor Documentation

◆ FileSystem() [1/2]

te::core::FileSystem::FileSystem ( )

private

◆ ~FileSystem()

te::core::FileSystem::~FileSystem ( )

private

◆ FileSystem() [2/2]

te::core::FileSystem::FileSystem ( FileSystem const & )

private

Member Function Documentation

◆ absolutePath()

static std::string te::core::FileSystem::absolutePath ( const std::string & path )

static

Retrives the absolute path for the given path in UTF-8.

Parameters

path	Path in UTF-8.

Returns: String in UTF-8 for the absolute path.

◆ copyFile()

static void te::core::FileSystem::copyFile	(	const std::string &	from,
		const std::string &	to
	)

static

Copies a file.

Parameters

from	Path in UTF-8 for the file to be copied.
to	Path in UTF-8 for the copy output.

◆ createDirectories()

static bool te::core::FileSystem::createDirectories ( const std::string & path )

static

Creates a directory for any element of path that does not exist.

Parameters

path	Path in UTF-8.

Returns: true if a new directory was created, otherwise false.

◆ createDirectory()

static bool te::core::FileSystem::createDirectory ( const std::string & path )

static

Creates a directory from a given path in UTF-8.

Parameters

path	Path in UTF-8.

Returns: true if a new directory was created, otherwise false.

◆ currentPath()

static std::string te::core::FileSystem::currentPath ( )

static

Retrives the current working directory path in UTF-8.

Returns: String in UTF-8 for the current working directory path.

◆ executableDirectory()

static std::string te::core::FileSystem::executableDirectory ( )

static

◆ exists()

static bool te::core::FileSystem::exists ( const std::string & path )

static

Checks if a given path in UTF-8 exists.

Parameters

path	Path in UTF-8.

Returns: true if exists, otherwise false.

◆ extension()

static std::string te::core::FileSystem::extension ( const std::string & path )

static

Retrives the extension of a given file path in UTF-8.

Parameters

path	File path in UTF-8.

Returns: String in UTF-8 for the extension.

◆ fileName()

static std::string te::core::FileSystem::fileName ( const std::string & path )

static

Retrives the filename of a given file path in UTF-8, including extension.

Parameters

path	File path in UTF-8.

Returns: String in UTF-8 for the name of the file, including the extension.

◆ fileSize()

static uintmax_t te::core::FileSystem::fileSize ( const std::string & path )

static

Returns the file size of a FILE in UTF-8.

Parameters

path	Path in UTF-8.

Returns: File size.

Exceptions

te::core::Exception if the given path doesn't exists or its used in a directory.

◆ isDirectory()

static bool te::core::FileSystem::isDirectory ( const std::string & path )

static

Checks if a given path in UTF-8 is a directory.

Parameters

path	Path in UTF-8.

Returns: true if is a directory, otherwise false.

◆ isEmpty()

static bool te::core::FileSystem::isEmpty ( const std::string & path )

static

Checks if a given path in UTF-8 is an empty directory.

Parameters

path	Path in UTF-8.

Returns: true if is a empty directory, otherwise false.

◆ isRegularFile()

static bool te::core::FileSystem::isRegularFile ( const std::string & path )

static

Checks if a given path in UTF-8 is a regular file.

Parameters

path	File path in UTF-8.

Returns: true if is a regular file, otherwise false.

Referenced by te::common::ApplicationSettings::load().

◆ listDirectory()

static std::vector<std::string> te::core::FileSystem::listDirectory ( const std::string & path )

static

Lists a directory from a given path in UTF-8.

Parameters

path	Path in UTF-8.

Returns: Vector of strings in UTF-8 for directory content.

◆ operator=()

FileSystem& te::core::FileSystem::operator= ( FileSystem const & )

private

◆ parentPath()

static std::string te::core::FileSystem::parentPath ( const std::string & path )

static

Retrives the parent path of a given file path in UTF-8. For /home/files/fileName.shp, it will return /home/files.

Parameters

path	File path in UTF-8.

Returns: String in UTF-8 for the parent path of the give file path.

◆ remove()

static bool te::core::FileSystem::remove ( const std::string & path )

static

Removes a file or directory from a given path in UTF-8.

Note: This function will not remove if the directory is not empty.

Parameters

path	Path in UTF-8.

Returns: false if path did not exist in the first place, otherwise true.

Referenced by te::common::ApplicationSettings::update().

◆ rename()

static void te::core::FileSystem::rename	(	const std::string &	old_p,
		const std::string &	new_p
	)

static

Renames a file or directory from a given path in UTF-8.

Parameters

old_p	Old name in UTF-8.
new_p	New name in UTF-8.

◆ stem()

static std::string te::core::FileSystem::stem ( const std::string & path )

static

Retrives the filename of a given file path in UTF-8, excluding extension.

Parameters

path	File path in UTF-8.

Returns: String in UTF-8 for the name of the file, excluding the extension.

◆ systemCompletePath()

static std::string te::core::FileSystem::systemCompletePath ( const std::string & path )

static

Composes an absolute path for the given path in UTF-8.

Parameters

path	Path in UTF-8.

Returns: String in UTF-8 for the composed path.

◆ tempDirectoryPath()

static std::string te::core::FileSystem::tempDirectoryPath ( )

static

Retrives the temp directory in UTF-8.

Returns: String in UTF-8 for temp directory.

◆ uniquePath()

static std::string te::core::FileSystem::uniquePath ( const std::string & format = "%%%%-%%%%-%%%%-%%%%" )

static

Retrives an unique path generated by a given format.

Parameters

format The format used to create a unique path. e.g.: "%%%%-%%%%-%%%%-%%%%"

Returns: String in UTF-8 for the generated unique path.

Referenced by te::rp::Matrix< rg::BaatzFeatureType >::createNewDiskFile().

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/core/filesystem/FileSystem.h

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FileSystem() [1/2]

◆ ~FileSystem()

◆ FileSystem() [2/2]

Member Function Documentation

◆ absolutePath()

◆ copyFile()

◆ createDirectories()

◆ createDirectory()

◆ currentPath()

◆ executableDirectory()

◆ exists()

◆ extension()

◆ fileName()

◆ fileSize()

◆ isDirectory()

◆ isEmpty()

◆ isRegularFile()

◆ listDirectory()

◆ operator=()

◆ parentPath()

◆ remove()

◆ rename()

◆ stem()

◆ systemCompletePath()

◆ tempDirectoryPath()

◆ uniquePath()