    

 ## On this page

  

 

 # ProjectStoragePolicy

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1\#ifndef CFFSDK\_PROJECT\_PROJECTSTORAGEPOLICY\_H

<a id="l00002" name="l00002"></a> 2\#define CFFSDK\_PROJECT\_PROJECTSTORAGEPOLICY\_H

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4\#include "Project/LibraryType.hpp"

<a id="l00005" name="l00005"></a> 5\#include "Project/Error.hpp"

<a id="l00006" name="l00006"></a> 6\#include "Project/URL.hpp"

<a id="l00007" name="l00007"></a> 7\#include &lt;map&gt;

<a id="l00008" name="l00008"></a> 8\#include &lt;string&gt;

<a id="l00009" name="l00009"></a> 9 

<a id="l00010" name="l00010"></a> 10namespace [ansys](namespaceansys.xhtml) {

<a id="l00011" name="l00011"></a> 11namespace Project {

<a id="l00012" name="l00012"></a> 12 

<a id="l00013" name="l00013"></a> 13class MetadataHoof;

<a id="l00014" name="l00014"></a> 14 

<a id="l00015" name="l00015"></a>[ 15](classansys_1_1_project_1_1_project_storage_policy.xhtml)class ANSYS_PROJECT_DLL [ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml) {

<a id="l00016" name="l00016"></a> 16public:

<a id="l00017" name="l00017"></a> 17 [ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml)(const std::string pName);

<a id="l00018" name="l00018"></a> 18 

<a id="l00019" name="l00019"></a> 19 // Persistent - Stored in project policy

<a id="l00020" name="l00020"></a> 20 void setProjectSubfolderEnabled(bool pFlag);

<a id="l00021" name="l00021"></a> 21 bool isProjectSubfolderEnabled() const;

<a id="l00022" name="l00022"></a> 22 

<a id="l00023" name="l00023"></a> 23 void setSubProjectMode(const std::string&amp; pSubprojectMode);

<a id="l00024" name="l00024"></a> 24 std::string getSubProjectMode() const;

<a id="l00025" name="l00025"></a> 25 

<a id="l00026" name="l00026"></a> 26 void setSimFolderName(const std::string&amp; pName);

<a id="l00027" name="l00027"></a> 27 std::string getSimFolderName() const;

<a id="l00028" name="l00028"></a> 28 

<a id="l00029" name="l00029"></a> 29 void setProjectSubfolderSuffix(const std::string&amp; pSuffix);

<a id="l00030" name="l00030"></a> 30 std::string getProjectSubfolderSuffix() const;

<a id="l00031" name="l00031"></a> 31 

<a id="l00032" name="l00032"></a> 32 void setProjectSubfolderCustomName(const std::string&amp; pCustomFolder);

<a id="l00033" name="l00033"></a> 33 std::string getProjectSubfolderCustomName() const;

<a id="l00034" name="l00034"></a> 34 

<a id="l00035" name="l00035"></a> 35 void setAttr(const std::string&amp; pKey,const std::string&amp; pValue);

<a id="l00036" name="l00036"></a> 36 std::string getAttr(const std::string&amp; pKey) const;

<a id="l00037" name="l00037"></a> 37 

<a id="l00038" name="l00038"></a> 38 void saveToMeta(MetadataHoof&amp; pMeta);

<a id="l00039" name="l00039"></a> 39 void loadFromMeta(const MetadataHoof&amp; pMeta);

<a id="l00040" name="l00040"></a> 40 

<a id="l00041" name="l00041"></a> 41 // Runtime - Not stored in project file policy

<a id="l00042" name="l00042"></a> 42 void setReadOnly(bool pFlag);

<a id="l00043" name="l00043"></a> 43 bool isReadOnly() const;

<a id="l00044" name="l00044"></a> 44 

<a id="l00045" name="l00045"></a> 45 void setApplicationName(const std::string&amp; pName);

<a id="l00046" name="l00046"></a> 46 std::string getApplicationName() const;

<a id="l00047" name="l00047"></a> 47 

<a id="l00048" name="l00048"></a> 48 [URL](classansys_1_1_project_1_1_u_r_l.xhtml) getLockInfoFilename(const [URL](classansys_1_1_project_1_1_u_r_l.xhtml)&amp; pProjectLocation) const;

<a id="l00049" name="l00049"></a> 49 void setUseLockInfo(bool pUseFeature,bool pUseInReadOnly=false);

<a id="l00050" name="l00050"></a> 50 bool isLockInfoEnabled() const;

<a id="l00051" name="l00051"></a> 51 bool isLockInfoOnReadOnlyEnabled() const;

<a id="l00052" name="l00052"></a> 52 

<a id="l00053" name="l00053"></a> 53 void setAutoUpgradeEnabled(bool pFlag);

<a id="l00054" name="l00054"></a> 54 bool getAutoUpgradeEnabled() const;

<a id="l00055" name="l00055"></a> 55 

<a id="l00056" name="l00056"></a> 56private:

<a id="l00057" name="l00057"></a> 57 bool aReadOnly;

<a id="l00058" name="l00058"></a> 58 std::string aAppName;

<a id="l00059" name="l00059"></a> 59 

<a id="l00060" name="l00060"></a> 60 bool aLockInfoEnabled;

<a id="l00061" name="l00061"></a> 61 bool aLockInfoOnReadOnlyEnabled;

<a id="l00062" name="l00062"></a> 62 

<a id="l00063" name="l00063"></a> 63 bool aAutoUpgradeEnabled;

<a id="l00064" name="l00064"></a> 64 

<a id="l00065" name="l00065"></a> 65 std::map&lt;std::string,std::string&gt; aAttr;

<a id="l00066" name="l00066"></a> 66};

<a id="l00067" name="l00067"></a> 67 

<a id="l00068" name="l00068"></a> 68}

<a id="l00069" name="l00069"></a> 69}

<a id="l00070" name="l00070"></a> 70 

<a id="l00071" name="l00071"></a> 71\#endif // CFFSDK\_PROJECT\_PROJECTSTORAGEPOLICY\_H

[ansys::Project::ProjectStoragePolicy](classansys_1_1_project_1_1_project_storage_policy.xhtml)

Project storage settings, control folder management, folder names, etc.

**Definition:** ProjectStoragePolicy.hpp:15



[ansys::Project::URL](classansys_1_1_project_1_1_u_r_l.xhtml)

The address of a local or remote file, using the URI format.

**Definition:** URL.hpp:12



[ansys](namespaceansys.xhtml)

**Definition:** API.dox:1