Utility class implementing the IFileInterface class. More...

#include "murl_util_tools_file_interface.h"

Inheritance diagram for Murl::Util::ToolsFileInterface:

Public Member Functions

 ToolsFileInterface ()
 The default constructor.
 
virtual ~ToolsFileInterface ()
 The destructor.
 
virtual Bool FileExists (const String &name, IEnums::FileCategory category)
 Implementation of IFileInterface::FileExists(). More...
 
virtual Bool FolderExists (const String &name, IEnums::FileCategory category)
 Implementation of IFileInterface::FolderExists(). More...
 
- Public Member Functions inherited from Murl::Util::FileInterface
 FileInterface ()
 The constructor.
 
virtual ~FileInterface ()
 The destructor.
 
virtual Bool GetAbsoluteName (const String &relativeName, IEnums::FileCategory category, String &absoluteName)
 Implementation of IFileInterface::GetAbsoluteName(). More...
 
virtual Bool GetAllFileNames (const String &relativePath, IEnums::FileCategory category, StringArray &names)
 Implementation of IFileInterface::GetAllFileNames(). More...
 
virtual Bool GetAllFolderNames (const String &relativePath, IEnums::FileCategory category, StringArray &names)
 Implementation of IFileInterface::GetAllFolderNames(). More...
 
virtual IFileOpenFile (const String &name, IEnums::FileCategory category, IEnums::FileAccessMode mode, Bool createFolders)
 Implementation of IFileInterface::OpenFile(). More...
 
virtual Bool CloseFile (IFile *&handle)
 Implementation of IFileInterface::CloseFile(). More...
 
virtual Bool MapFileData (const String &name, IEnums::FileCategory category, ConstData &data)
 Implementation of IFileInterface::MapFileData(). More...
 
virtual Bool UnmapFileData (ConstData &data)
 Implementation of IFileInterface::UnmapFileData(). More...
 

Protected Member Functions

virtual Bool MapFile (const String &name, IEnums::FileCategory category, const UInt8 *&data, UInt64 &byteSize)
 Implementation of FileInterface::MapFile(). More...
 
virtual Bool UnmapFile (const UInt8 *data)
 Implementation of FileInterface::UnmapFile(). More...
 
virtual Bool CreateFolder (const String &absolutePath)
 Implementation of FileInterface::CreateFolder(). More...
 
virtual Bool GetAbsolutePath (IEnums::FileCategory category, String &absolutePath)
 Implementation of FileInterface::GetAbsolutePath(). More...
 

Protected Attributes

Index< const UInt8 * > mMappedFiles
 The mapped files memory pointer storage. More...
 

Detailed Description

Utility class implementing the IFileInterface class.

The tools file interface class is intend for tools development and supports the file category IEnums::FILE_CATEGORY_CURRENT and IEnums::FILE_CATEGORY_ROOT only.

Member Function Documentation

◆ FileExists()

virtual Bool Murl::Util::ToolsFileInterface::FileExists ( const String name,
IEnums::FileCategory  category 
)
virtual

Implementation of IFileInterface::FileExists().

Parameters
nameThe name of the file.
categoryThe category where the file reside.
Returns
true if the file exists.

Implements Murl::IFileInterface.

◆ FolderExists()

virtual Bool Murl::Util::ToolsFileInterface::FolderExists ( const String name,
IEnums::FileCategory  category 
)
virtual

Implementation of IFileInterface::FolderExists().

Parameters
nameThe name of the folder.
categoryThe category where the folder reside.
Returns
true if the folder exists.

Implements Murl::IFileInterface.

◆ MapFile()

virtual Bool Murl::Util::ToolsFileInterface::MapFile ( const String name,
IEnums::FileCategory  category,
const UInt8 *&  data,
UInt64 byteSize 
)
protectedvirtual

Implementation of FileInterface::MapFile().

Parameters
nameThe name of the file.
categoryThe category where the file reside.
dataThe file data pointer return value.
byteSizeThe byte size return value.
Returns
true if successful, if false the return values stay unchanged.

Implements Murl::Util::FileInterface.

◆ UnmapFile()

virtual Bool Murl::Util::ToolsFileInterface::UnmapFile ( const UInt8 data)
protectedvirtual

Implementation of FileInterface::UnmapFile().

Parameters
dataThe mapped file data pointer.
Returns
true if successful.

Implements Murl::Util::FileInterface.

◆ CreateFolder()

virtual Bool Murl::Util::ToolsFileInterface::CreateFolder ( const String absolutePath)
protectedvirtual

Implementation of FileInterface::CreateFolder().

Parameters
absolutePathThe path of the folder to create.
Returns
true if successful.

Implements Murl::Util::FileInterface.

◆ GetAbsolutePath()

virtual Bool Murl::Util::ToolsFileInterface::GetAbsolutePath ( IEnums::FileCategory  category,
String absolutePath 
)
protectedvirtual

Implementation of FileInterface::GetAbsolutePath().

Parameters
categoryThe category of the folder.
absolutePathThe path of the folder return value.
Returns
true if successful.

Implements Murl::Util::FileInterface.

Member Data Documentation

◆ mMappedFiles

Index<const UInt8*> Murl::Util::ToolsFileInterface::mMappedFiles
protected

The mapped files memory pointer storage.


The documentation for this class was generated from the following file:
  • murl_util_tools_file_interface.h


Copyright © 2011-2018 Spraylight GmbH.