libosmscout  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups
Platform independent file access

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

Classes

class  osmscout::CLASS_FINAL
 Representation of an (complex/multipolygon) area. More...
 
class  osmscout::HTMLWriter
 HTMLWriter allows easy generation of HTML web pages containing OSM based reports. More...
 

Functions

OSMSCOUT_API std::string osmscout::AppendFileToDir (const std::string &dir, const std::string &file)
 Append the filename 'name' to the directory name 'name' correctly adding directory delimiter if necessary. More...
 
OSMSCOUT_API uint8_t osmscout::BytesNeededToAddressFileData (const std::string &filename)
 Number of bytes needed to address the complete content of the given file. More...
 
OSMSCOUT_API bool osmscout::ExistsInFilesystem (const std::string &filename)
 Returns true of the given filename exists in the filesystem. More...
 
OSMSCOUT_API FileOffset osmscout::GetFileSize (const std::string &filename)
 Return the size of the file in the parameter size. More...
 
OSMSCOUT_API bool osmscout::IsDirectory (const std::string &filename)
 Returns true of the given filename points to a directory. More...
 
OSMSCOUT_API bool osmscout::RemoveFile (const std::string &filename)
 Deletes the given file. More...
 
OSMSCOUT_API bool osmscout::RenameFile (const std::string &oldFilename, const std::string &newFilename)
 Rename a file. More...
 

Detailed Description

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

Function Documentation

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

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

Exceptions
IOException

References osmscout::BytesNeededToEncodeNumber(), and osmscout::GetFileSize().

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

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
IOExceptionif the function is not implemented.
FileOffset osmscout::GetFileSize ( const std::string &  filename)

Return the size of the file in the parameter size.

Exceptions
IOException

Referenced by osmscout::BytesNeededToAddressFileData(), and osmscout::StyleConfig::Load().

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

Returns true of the given filename points to a directory.

Else it returns false.

Exceptions
IOExceptionif there was an error or if the function is not implemented.
bool osmscout::RemoveFile ( const std::string &  filename)

Deletes the given file.

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

Rename a file.