ansys::Project::ProjectStoragePolicy Class Reference
Last update: 16.07.2025Project storage settings, control folder management, folder names, etc. More...
#include "ProjectStoragePolicy.hpp"
Public Member Functions | |
| ProjectStoragePolicy (const std::string pName) | |
| Constructor - default storage policies. | |
| bool | isProjectSubfolderEnabled () const |
| indicates if the project is a managed project (with a sidecard folder to store files) | |
| std::string | getSubProjectMode () const |
| indicates the type of the subproject (the type of the head node of the subproject) - default state is none (empty string) | |
| std::string | getSimFolderName () const |
| returns the name of the simulation folder in the current policy (default is none) | |
| std::string | getProjectSubfolderSuffix () const |
| indicates the the filename suffix added to a project folder (default is .cffdb) | |
| std::string | getProjectSubfolderCustomName () const |
| indicates if the project folder has a specific name - default is none (will use project index filename + suffix) | |
| bool | isReadOnly () const |
| indicates if the project is read-only, cannot be saved back and many operations will fail | |
| std::string | getApplicationName () const |
| return the application owner of this project (optional - default is empty) | |
| URL | getLockInfoFilename (const URL &pProjectLocation) const |
| if project lock is enabled, returns the lock filename for the specified project location | |
| bool | isLockInfoEnabled () const |
| indicates if project lock feature is enabled | |
| bool | isLockInfoOnReadOnlyEnabled () const |
| indicates if project lock will prevent reading even in read-only mode | |
Detailed Description
Project storage settings, control folder management, folder names, etc.
The storage policy is to be set before creating a new project, or the read project settings can be retrieved after opening an existing project. The policy is saved in the project file itself.
Default policies:
