Platform independent file access

Collaboration diagram for Platform independent file access:

Classes
class	osmscout::CLASS_FINAL< DataLoader >
class	osmscout::HTMLWriter

Functions
OSMSCOUT_API FileOffset	osmscout::GetFileSize (const std::string &filename)
OSMSCOUT_API bool	osmscout::RemoveFile (const std::string &filename)
OSMSCOUT_API bool	osmscout::RenameFile (const std::string &oldFilename, const std::string &newFilename)
OSMSCOUT_API std::string	osmscout::GetDirectory (const std::string &file)
OSMSCOUT_API std::string	osmscout::AppendFileToDir (const std::string &dir, const std::string &file)
OSMSCOUT_API uint8_t	osmscout::BytesNeededToAddressFileData (const std::string &filename)
OSMSCOUT_API bool	osmscout::ExistsInFilesystem (const std::string &filename)
OSMSCOUT_API bool	osmscout::IsDirectory (const std::string &filename)

Detailed Description

Classes and methods related to low-level platform independent access to files on disk.

Function Documentation

AppendFileToDir()

OSMSCOUT_API std::string osmscout::AppendFileToDir ( const std::string & dir, const std::string & file )

extern

Append the filename 'name' to the directory name 'name' correctly adding directory delimiter if necessary.

BytesNeededToAddressFileData()

OSMSCOUT_API uint8_t osmscout::BytesNeededToAddressFileData ( const std::string & filename )

extern

Number of bytes needed to address the complete content of the given file.

Exceptions

IOException

ExistsInFilesystem()

OSMSCOUT_API bool osmscout::ExistsInFilesystem ( const std::string & filename )

extern

Returns true of the given filename exists in the filesystem. Else it returns false.

Note that this function returns, does not tell you anything about the type of the filesystem entry. It you still be a regular file, a directory, a pipe or something completely different.

Also not ethat there is no differenciation in error codes. If there was an error during access to the file entry while though the file entry does in fact exists, false ist still returned.

Exceptions

IOException

if the function is not implemented.

GetDirectory()

OSMSCOUT_API std::string osmscout::GetDirectory ( const std::string & file )

extern

Return everything (including the delimiter) before the last path delimiter. Returns empty string, if there is no delimiter.

GetFileSize()

OSMSCOUT_API FileOffset osmscout::GetFileSize ( const std::string & filename )

extern

Return the size of the file in the parameter size.

Exceptions

IOException

IsDirectory()

OSMSCOUT_API bool osmscout::IsDirectory ( const std::string & filename )

extern

Returns true of the given filename points to a directory. Else it returns false.

Exceptions

IOException

if there was an error or if the function is not implemented.

RemoveFile()

OSMSCOUT_API bool osmscout::RemoveFile ( const std::string & filename )

extern

Deletes the given file

RenameFile()

OSMSCOUT_API bool osmscout::RenameFile ( const std::string & oldFilename, const std::string & newFilename )

extern

Rename a file