## 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_2024_r2/classansys_1_1_project_1_1_storage_filesystem.png)



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

<a id="aef85785d0bc52cf31f48164a6ec9098a" name="aef85785d0bc52cf31f48164a6ec9098a"></a> **StorageFilesystem** () Constructor.   
 <a id="a76412fa4d48e205706a1431f1cf85996" name="a76412fa4d48e205706a1431f1cf85996"></a>virtual **~StorageFilesystem** () Destructor.   
 <a id="a123e1a2a831423afe21b4332e6ce0236" name="a123e1a2a831423afe21b4332e6ce0236"></a>[Error](classansys_1_1_project_1_1_error.xhtml) **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) See [Storage::createFolder()](classansys_1_1_project_1_1_storage.xhtml#a5425696f2817236f5886b54dc3cd1ac9 "Create a folder in the specified URL, using the specified name.")   
 <a id="aeae85eee1f1895be16cc074c2f210be4" name="aeae85eee1f1895be16cc074c2f210be4"></a>virtual bool **isFolder** (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.")   
 <a id="a1c20950181bd70ba4cc45e539288e09f" name="a1c20950181bd70ba4cc45e539288e09f"></a>virtual bool **isFile** (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.")   
 <a id="a384d3752e0537b2f74d684bf890f1e67" name="a384d3752e0537b2f74d684bf890f1e67"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **copyFile** (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.")   
 <a id="ab42176b62556669397ba33e1a5238a12" name="ab42176b62556669397ba33e1a5238a12"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **eraseFile** (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.")   
 <a id="aece46fb1eab83d340f92bfeaff6b9569" name="aece46fb1eab83d340f92bfeaff6b9569"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **eraseFolder** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile, EraseOptions pRecursive) See [Storage::eraseFolder()](classansys_1_1_project_1_1_storage.xhtml#ae3c62e8ea9637b802eebe488e4a62fe4 "Erase the folder and content at the specified location.")   
 <a id="afbb37c05fcf05d79db86bfb4b3cba4ec" name="afbb37c05fcf05d79db86bfb4b3cba4ec"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **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) See [Storage::moveFile()](classansys_1_1_project_1_1_storage.xhtml#a1eb6dbf782620c41e87dda556d3989b8 "Rename the file or folder.")   
 <a id="a577705e0cfe27c0f9b58ec0f95c280dd" name="a577705e0cfe27c0f9b58ec0f95c280dd"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **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) See [Storage::matchFiles()](classansys_1_1_project_1_1_storage.xhtml#a6069a427195a8247e9f78803d4ff520f "File query by wildcard pattern in the specified URL.")   
 <a id="a1be30dbb6aac0f0a9f66df7313608810" name="a1be30dbb6aac0f0a9f66df7313608810"></a>virtual std::string **getFileCompressionSuffix** () const Returns the required file suffix for compressFile API.   
 <a id="a330746e96245fb171a6508fb7bb52ac5" name="a330746e96245fb171a6508fb7bb52ac5"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **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) See Storage::compressFile()   
 <a id="ad9efc72d9decce9ba776d778f6d09e1c" name="ad9efc72d9decce9ba776d778f6d09e1c"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **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) See [Storage::extractFile()](classansys_1_1_project_1_1_storage.xhtml#abe1ec2924e9c518adc1a9207a65f5dd0 "Extract a zipped archive to the specified location.")   
 <a id="acf398f76d7b193aaf9dac8e636d3ffb9" name="acf398f76d7b193aaf9dac8e636d3ffb9"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **getFileTimestamp** (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFile, int &amp;pTime) See Storage::getFileTimeStamp()   
 <a id="a039595fe58e424d1d2fa26b65c61bc89" name="a039595fe58e424d1d2fa26b65c61bc89"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **getFileChecksum** (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.")   
 ![-](/sites/default/files/migrate-content/common_fluids_format_2024_r2/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)  
 <a id="a0a620fa8087cbd638207d4cab5c541bd" name="a0a620fa8087cbd638207d4cab5c541bd"></a>virtual **~Storage** () Destructor.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/common_fluids_format_2024_r2/closed.png) Static Public Member Functions inherited from [ansys::Project::Storage](classansys_1_1_project_1_1_storage.xhtml)<a id="a3f9f604fc9b1d14b05acd8ee3ff7b98e" name="a3f9f604fc9b1d14b05acd8ee3ff7b98e"></a>static void **registerInterface** (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.   
 <a id="abdef10f9ae138161ef673d5cc516f83b" name="abdef10f9ae138161ef673d5cc516f83b"></a>static [Storage](classansys_1_1_project_1_1_storage.xhtml) \* **getInterface** (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.   
 <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.")