## On this page

  

 

 # ansys::Project::StorageFilesystem Class Reference

 Last update: 16.07.2025 

Class for [Storage](classansys_1_1_project_1_1_storage.xhtml "Base class for file storage management module.") on standard filesystem, for <file://> [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format."). [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#details)

`#include "StorageFilesystem.hpp"`

Inheritance diagram for ansys::Project::StorageFilesystem:

 ![](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/classansys_1_1_project_1_1_storage_filesystem.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [StorageFilesystem](classansys_1_1_project_1_1_storage_filesystem.xhtml#aef85785d0bc52cf31f48164a6ec9098a) () Constructor. [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#aef85785d0bc52cf31f48164a6ec9098a)  
 virtual [~StorageFilesystem](classansys_1_1_project_1_1_storage_filesystem.xhtml#a76412fa4d48e205706a1431f1cf85996) () Destructor. [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a76412fa4d48e205706a1431f1cf85996)  
 [Error](classansys_1_1_project_1_1_error.xhtml) [createFolder](classansys_1_1_project_1_1_storage_filesystem.xhtml#a123e1a2a831423afe21b4332e6ce0236) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pParentPath, const [Path](classansys_1_1_project_1_1_path.xhtml) &amp;pFolderPath) See [Storage::createFolder()](classansys_1_1_project_1_1_storage.xhtml#a5425696f2817236f5886b54dc3cd1ac9 "Create a folder in the specified URL, using the specified name.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a123e1a2a831423afe21b4332e6ce0236)  
 virtual bool [isFolder](classansys_1_1_project_1_1_storage_filesystem.xhtml#aeae85eee1f1895be16cc074c2f210be4) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pPath) See [Storage::isFolder()](classansys_1_1_project_1_1_storage.xhtml#a5809221b3618eb84e4eebaf0357af195 "Indicates if a folder exists at the specified URL.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#aeae85eee1f1895be16cc074c2f210be4)  
 virtual bool [isFile](classansys_1_1_project_1_1_storage_filesystem.xhtml#a1c20950181bd70ba4cc45e539288e09f) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pPath) See [Storage::isFile()](classansys_1_1_project_1_1_storage.xhtml#a8b8642b9831aa539f231897e48cf3298 "Indicates if a file exists at the specified URL.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a1c20950181bd70ba4cc45e539288e09f)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [copyFile](classansys_1_1_project_1_1_storage_filesystem.xhtml#a384d3752e0537b2f74d684bf890f1e67) (const std::string &amp;pSource, const std::string &amp;pTarget) See [Storage::copyFile()](classansys_1_1_project_1_1_storage.xhtml#ad95b9bf3b4c5dba9ab6768f70d1ebbc5 "Copy file from source to location, can be two different URL types.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a384d3752e0537b2f74d684bf890f1e67)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [eraseFile](classansys_1_1_project_1_1_storage_filesystem.xhtml#ab42176b62556669397ba33e1a5238a12) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile) See [Storage::eraseFile()](classansys_1_1_project_1_1_storage.xhtml#ab2f8205ecdd044f7718cea9881c94dfc "Erase the file at the specified location.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#ab42176b62556669397ba33e1a5238a12)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [eraseFolder](classansys_1_1_project_1_1_storage_filesystem.xhtml#aece46fb1eab83d340f92bfeaff6b9569) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile, [EraseOptions](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727f) pRecursive) See [Storage::eraseFolder()](classansys_1_1_project_1_1_storage.xhtml#ae3c62e8ea9637b802eebe488e4a62fe4 "Erase the folder and content at the specified location.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#aece46fb1eab83d340f92bfeaff6b9569)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [moveFile](classansys_1_1_project_1_1_storage_filesystem.xhtml#afbb37c05fcf05d79db86bfb4b3cba4ec) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pSource, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTarget) See [Storage::moveFile()](classansys_1_1_project_1_1_storage.xhtml#a1eb6dbf782620c41e87dda556d3989b8 "Rename the file or folder.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#afbb37c05fcf05d79db86bfb4b3cba4ec)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [matchFiles](classansys_1_1_project_1_1_storage_filesystem.xhtml#a577705e0cfe27c0f9b58ec0f95c280dd) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pPath, std::string pWildcard, std::vector&lt; [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &gt; &amp;pMatchFiles) See [Storage::matchFiles()](classansys_1_1_project_1_1_storage.xhtml#a6069a427195a8247e9f78803d4ff520f "File query by wildcard pattern in the specified URL.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a577705e0cfe27c0f9b58ec0f95c280dd)  
 virtual std::string [getFileCompressionSuffix](classansys_1_1_project_1_1_storage_filesystem.xhtml#a1be30dbb6aac0f0a9f66df7313608810) () const Returns the required file suffix for compressFile API. [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a1be30dbb6aac0f0a9f66df7313608810)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [compressFiles](classansys_1_1_project_1_1_storage_filesystem.xhtml#a330746e96245fb171a6508fb7bb52ac5) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pRootFolder, std::vector&lt; [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &gt; &amp;pSourceFiles, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetArchive) See Storage::compressFile() [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a330746e96245fb171a6508fb7bb52ac5)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [extractFile](classansys_1_1_project_1_1_storage_filesystem.xhtml#ad9efc72d9decce9ba776d778f6d09e1c) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pArchive, const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pTargetLocation) See [Storage::extractFile()](classansys_1_1_project_1_1_storage.xhtml#abe1ec2924e9c518adc1a9207a65f5dd0 "Extract a zipped archive to the specified location.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#ad9efc72d9decce9ba776d778f6d09e1c)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [getFileTimestamp](classansys_1_1_project_1_1_storage_filesystem.xhtml#acf398f76d7b193aaf9dac8e636d3ffb9) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile, int &amp;pTime) See Storage::getFileTimeStamp() [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#acf398f76d7b193aaf9dac8e636d3ffb9)  
 virtual [Error](classansys_1_1_project_1_1_error.xhtml) [getFileChecksum](classansys_1_1_project_1_1_storage_filesystem.xhtml#a039595fe58e424d1d2fa26b65c61bc89) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile, std::string &amp;pChecksum) See [Storage::getFileChecksum()](classansys_1_1_project_1_1_storage.xhtml#a0ad50007b1ad077038e823eb3bb21b7d "Compute a checksum for the specified file.") [More...](classansys_1_1_project_1_1_storage_filesystem.xhtml#a039595fe58e424d1d2fa26b65c61bc89)  
 ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Public Member Functions inherited from [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml) [Storage](classansys_1_1_project_1_1_storage.xhtml#a2374cab30c3fe446708866f0c24351cc) (const std::string &amp;pTypename) Constructor. [More...](classansys_1_1_project_1_1_storage.xhtml#a2374cab30c3fe446708866f0c24351cc)  
 virtual [~Storage](classansys_1_1_project_1_1_storage.xhtml#a0a620fa8087cbd638207d4cab5c541bd) () Destructor. [More...](classansys_1_1_project_1_1_storage.xhtml#a0a620fa8087cbd638207d4cab5c541bd)  
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Public Types inherited from [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml)enum [EraseOptions](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727f) { [EraseFolderOnly](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727fa0a93151649911c33b4432bdeafc4f9aa), [EraseFolderAndFiles](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727fabe6d6df4e50d365a3d6c3e0d3d36ef4c), [EraseRecursively](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727fabf7a9bc30546a00063f135d272445fd7) } ![-](/sites/default/files/migrate-content/common_fluids_format_2025_r2_1/closed.png) Static Public Member Functions inherited from [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml)static void [registerInterface](classansys_1_1_project_1_1_storage.xhtml#a3f9f604fc9b1d14b05acd8ee3ff7b98e) (const std::string &amp;pType, [Storage](classansys_1_1_project_1_1_storage.xhtml) \*pInterface) Register a [Storage](classansys_1_1_project_1_1_storage.xhtml "Base class for file storage management module.") object to work with a specific [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") type. [More...](classansys_1_1_project_1_1_storage.xhtml#a3f9f604fc9b1d14b05acd8ee3ff7b98e)  
 static [Storage](classansys_1_1_project_1_1_storage.xhtml) \* [getInterface](classansys_1_1_project_1_1_storage.xhtml#abdef10f9ae138161ef673d5cc516f83b) (const std::string &amp;pType) Retrieve the [Storage](classansys_1_1_project_1_1_storage.xhtml "Base class for file storage management module.") object to use with a specific [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") type. [More...](classansys_1_1_project_1_1_storage.xhtml#abdef10f9ae138161ef673d5cc516f83b)  
 <a id="details" name="details"></a>## Detailed Description

Class for [Storage](classansys_1_1_project_1_1_storage.xhtml "Base class for file storage management module.") on standard filesystem, for <file://> [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.").

See [Storage](classansys_1_1_project_1_1_storage.xhtml "Base class for file storage management module.")



## Constructor &amp; Destructor Documentation

<a id="aef85785d0bc52cf31f48164a6ec9098a" name="aef85785d0bc52cf31f48164a6ec9098a"></a>## [◆ ](#aef85785d0bc52cf31f48164a6ec9098a)StorageFilesystem()

 ansys::Project::StorageFilesystem::StorageFilesystem  ( ) 

Constructor.





<a id="a76412fa4d48e205706a1431f1cf85996" name="a76412fa4d48e205706a1431f1cf85996"></a>## [◆ ](#a76412fa4d48e205706a1431f1cf85996)~StorageFilesystem()

 ansys::Project::StorageFilesystem::~StorageFilesystem  ( )   virtual 

Destructor.





## Member Function Documentation

<a id="a330746e96245fb171a6508fb7bb52ac5" name="a330746e96245fb171a6508fb7bb52ac5"></a>## [◆ ](#a330746e96245fb171a6508fb7bb52ac5)compressFiles()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::compressFiles  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pRootFolder*,    std::vector&lt; [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &gt; &amp;  *pSourceFiles*,    const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pTargetArchive*   )   virtual 

See Storage::compressFile()

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a4c42b21f9f607bbff1940ad3dbbcf6d9).





<a id="a384d3752e0537b2f74d684bf890f1e67" name="a384d3752e0537b2f74d684bf890f1e67"></a>## [◆ ](#a384d3752e0537b2f74d684bf890f1e67)copyFile()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::copyFile  ( const std::string &amp;  *pSource*,    const std::string &amp;  *pTarget*   )   virtual 

See [Storage::copyFile()](classansys_1_1_project_1_1_storage.xhtml#ad95b9bf3b4c5dba9ab6768f70d1ebbc5 "Copy file from source to location, can be two different URL types.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#ad95b9bf3b4c5dba9ab6768f70d1ebbc5).





<a id="a123e1a2a831423afe21b4332e6ce0236" name="a123e1a2a831423afe21b4332e6ce0236"></a>## [◆ ](#a123e1a2a831423afe21b4332e6ce0236)createFolder()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::createFolder  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pParentPath*,    const [Path](classansys_1_1_project_1_1_path.xhtml) &amp;  *pFolderPath*   )   virtual 

See [Storage::createFolder()](classansys_1_1_project_1_1_storage.xhtml#a5425696f2817236f5886b54dc3cd1ac9 "Create a folder in the specified URL, using the specified name.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a5425696f2817236f5886b54dc3cd1ac9).





<a id="ab42176b62556669397ba33e1a5238a12" name="ab42176b62556669397ba33e1a5238a12"></a>## [◆ ](#ab42176b62556669397ba33e1a5238a12)eraseFile()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::eraseFile  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pFile*)   virtual 

See [Storage::eraseFile()](classansys_1_1_project_1_1_storage.xhtml#ab2f8205ecdd044f7718cea9881c94dfc "Erase the file at the specified location.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#ab2f8205ecdd044f7718cea9881c94dfc).





<a id="aece46fb1eab83d340f92bfeaff6b9569" name="aece46fb1eab83d340f92bfeaff6b9569"></a>## [◆ ](#aece46fb1eab83d340f92bfeaff6b9569)eraseFolder()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::eraseFolder  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pFile*,    [Storage::EraseOptions](classansys_1_1_project_1_1_storage.xhtml#a7a0ea834ae0902dfa37762ef350e727f)  *pFlagRecursive*   )   virtual 

See [Storage::eraseFolder()](classansys_1_1_project_1_1_storage.xhtml#ae3c62e8ea9637b802eebe488e4a62fe4 "Erase the folder and content at the specified location.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#ae3c62e8ea9637b802eebe488e4a62fe4).





<a id="ad9efc72d9decce9ba776d778f6d09e1c" name="ad9efc72d9decce9ba776d778f6d09e1c"></a>## [◆ ](#ad9efc72d9decce9ba776d778f6d09e1c)extractFile()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::extractFile  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pArchive*,    const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pTargetLocation*   )   virtual 

See [Storage::extractFile()](classansys_1_1_project_1_1_storage.xhtml#abe1ec2924e9c518adc1a9207a65f5dd0 "Extract a zipped archive to the specified location.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#abe1ec2924e9c518adc1a9207a65f5dd0).





<a id="a039595fe58e424d1d2fa26b65c61bc89" name="a039595fe58e424d1d2fa26b65c61bc89"></a>## [◆ ](#a039595fe58e424d1d2fa26b65c61bc89)getFileChecksum()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::getFileChecksum  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pFile*,    std::string &amp;  *pChecksum*   )   virtual 

See [Storage::getFileChecksum()](classansys_1_1_project_1_1_storage.xhtml#a0ad50007b1ad077038e823eb3bb21b7d "Compute a checksum for the specified file.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a0ad50007b1ad077038e823eb3bb21b7d).





<a id="a1be30dbb6aac0f0a9f66df7313608810" name="a1be30dbb6aac0f0a9f66df7313608810"></a>## [◆ ](#a1be30dbb6aac0f0a9f66df7313608810)getFileCompressionSuffix()

 std::string ansys::Project::StorageFilesystem::getFileCompressionSuffix  ( )  const  virtual 

Returns the required file suffix for compressFile API.

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#affb5603e8c05d4fb8b24c9d8547ef356).





<a id="acf398f76d7b193aaf9dac8e636d3ffb9" name="acf398f76d7b193aaf9dac8e636d3ffb9"></a>## [◆ ](#acf398f76d7b193aaf9dac8e636d3ffb9)getFileTimestamp()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::getFileTimestamp  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pFile*,    int &amp;  *pTime*   )   virtual 

See Storage::getFileTimeStamp()

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#ad6d0085c5c82a3e811ebeab6a6aeede8).





<a id="a1c20950181bd70ba4cc45e539288e09f" name="a1c20950181bd70ba4cc45e539288e09f"></a>## [◆ ](#a1c20950181bd70ba4cc45e539288e09f)isFile()

 bool ansys::Project::StorageFilesystem::isFile  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pPath*)   virtual 

See [Storage::isFile()](classansys_1_1_project_1_1_storage.xhtml#a8b8642b9831aa539f231897e48cf3298 "Indicates if a file exists at the specified URL.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a8b8642b9831aa539f231897e48cf3298).





<a id="aeae85eee1f1895be16cc074c2f210be4" name="aeae85eee1f1895be16cc074c2f210be4"></a>## [◆ ](#aeae85eee1f1895be16cc074c2f210be4)isFolder()

 bool ansys::Project::StorageFilesystem::isFolder  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pPath*)   virtual 

See [Storage::isFolder()](classansys_1_1_project_1_1_storage.xhtml#a5809221b3618eb84e4eebaf0357af195 "Indicates if a folder exists at the specified URL.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a5809221b3618eb84e4eebaf0357af195).





<a id="a577705e0cfe27c0f9b58ec0f95c280dd" name="a577705e0cfe27c0f9b58ec0f95c280dd"></a>## [◆ ](#a577705e0cfe27c0f9b58ec0f95c280dd)matchFiles()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::matchFiles  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pPath*,    std::string  *pWildcard*,    std::vector&lt; [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &gt; &amp;  *pMatchFiles*   )   virtual 

See [Storage::matchFiles()](classansys_1_1_project_1_1_storage.xhtml#a6069a427195a8247e9f78803d4ff520f "File query by wildcard pattern in the specified URL.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a6069a427195a8247e9f78803d4ff520f).





<a id="afbb37c05fcf05d79db86bfb4b3cba4ec" name="afbb37c05fcf05d79db86bfb4b3cba4ec"></a>## [◆ ](#afbb37c05fcf05d79db86bfb4b3cba4ec)moveFile()

 [Error](classansys_1_1_project_1_1_error.xhtml) ansys::Project::StorageFilesystem::moveFile  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pSource*,    const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pTarget*   )   virtual 

See [Storage::moveFile()](classansys_1_1_project_1_1_storage.xhtml#a1eb6dbf782620c41e87dda556d3989b8 "Rename the file or folder.")

Implements [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml#a1eb6dbf782620c41e87dda556d3989b8).