ansys::Project::Project Class Reference

Constructor.

A project should be created/opened with newProject()/openProject() Before creating a project, the storage policy should be set up, to configure whether the new project should be a free-storage or a managed project. See getStoragePolicy().

Compress the project to an archive (keeping current project opened and unchanged)

If the project is managed (project folder), flprj+folder are compressed If the project is free storage, all files referenced from project folder (in current or subfolders) are included. Files with global URLs or, relative URL going up (../) will not be saved in the archive.

Parameters

pTargetArchive

7z file to write

Compress the project to an archive (keeping current project opened and unchanged)

If the project is managed (project folder), flprj+folder are compressed If the project is free storage, all files referenced from project folder (in current or subfolders) are included. Files with global URLs or, relative URL going up (../) will not be saved in the archive.

Parameters

pTargetArchive	7z file to write
pListIgnore	list of file names or patterns to ignore

Check if a Project is valid.

Parameters

pSettings

CheckProjectInfo structure used to specify check project settings and return the results.

Reimplemented in ansys::Project::SimProject.

Close the project and release the lock.

All Iterators to this project will become invalid and will be unusable (!ok()).

Copy the Iterator item to the target project.

This operation only copies the project index data, not the files themselves. The URL pointed by the files is only valid if the new project is appropriately positioned.

Internal function - Copy a folder iterator content files from a source directory to target.

Parameters

pFolder	Iterator of a folder to copy.
pSourceFolder	Location of the storage for the folder.
pTargetFolder	Location of the storage for the new folder (folder must exist already).
pURLChanges	If Iterators would have their URL changed by saving a project to the new location, this index is to be filled with iterators and their new URL (setURL/getURL). In the case of a saveAsProject the URL changes are applied and kept, in the case of an export the URL changes are to be applied , the project saved, then restored.
pFlagCopyExternal	if enabled, external files and folders are copied to the new project location. if disabled, URL references are kept as is. If a file is stored in a unregistered subfolder, the same file structure is copied to the target location.
pFlagEnforceStructure	The project is saved to a project folder and subfolders are enforced to their Simulation/Run names.

Erase the project lock.

Parameters

pLocation

URL of the project file.

Export the project to a new location (keeping current project opened and unchanged).

This operation will copy/collate the files of the project.

Parameters

pLocation	New location and name of the flprj file
pFlagCopyExternal	If enabled, external files and folders are copied to the new project location. If disabled, URL references are kept as is
pFlagEnforceStructure	The project is saved to a project folder and subfolders are enforced to their Simulation/Run names.

Split the project at the specified location to a subproject.

The specified location (a folder iterator) becomes the new project root, and is linked as a subproject in the current project. A new project file is saved at the specified URL filename.

Parameters

pIter	Folder iterator to split as a subproject.
pPrjLocation	Location/name of the project index file, if a blank URL is provided, it is saved alongside the target folder, with the default project filename suffix (.flprj).
pNewProject	A blank, properly typed, project object to use (if forking a SimProject, use a SimProject target).

For a project Path, return the associated Iterator.

The Path is the internal project hiearchy, which might include hidden/virtual subfolders. To get the iterator from a file path on disk, see getIteratorForURL().

Return the metadata for the current iterator and include relevant data from parent iterators.

In Project this only returns the metadata for the current iterator, unless the parent item is a Transparent item, the data is then also included. Used in some UI elements.

Reimplemented in ansys::Project::SimProject.

Indicates if the specified project is locked and retrieve the lock information.

Parameters

pLocation	URL of the project to check.
pLockInfo	string indicating the lock source, empty string if no lock

Returns

Error if the lock info cannot be retrieved.

Load the specified subproject.

Parameters

pIter	Folder iterator to split as a subproject.
pPrjLocation	Location/name of the project index file, if a blank URL is provided, it is saved alongside the target folder, with the default project filename suffix (.flprj).
pNewProject	A blank, properly typed, project object to use (if forking a SimProject, use a SimProject target).

Create a project at the specified URL.

The URL is a folder with a *.flprj filename, the location must be writeable. A Storage plug-in must be loaded to accommodate the URL type. ( StorageFilesystem is always available for local file storage).

The Project is created from the currently configured ProjectStoragePolicy and a new folder is created alongside the *.flprj file, if applicable.

Open a project at the specified URL.

From the storage policies, opening the project might fail if the project is locked, or read-only not permitted if locked.

Parameters

pLocation	: Filename of the project (.flprj) file
pFlagReadOnly	: If read-only the project cannot be modified

Open a project by reading its data from a string.

Parameters

pProjectData	Project data, such as written by saveProjectToString()
pProjectLocation	Location on filesystem, assumed for relative URLs
pFlagReadOnly	If read-only, the project cannot be modified

Create a new object of the current effective project type.

Overridden at the SimProject level

Reimplemented in ansys::Project::SimProject.

Register a function callback to a project event.

Project events are generated by the project viewer UI contextMenuActions, itemDoubleClick, itemSelected, etc.

Parameters

pOwner	An identifier for the owner of this callback.
pCallbackName	One of the standard callback events offered by the project.
pCallback	The function callback to execute upon the event.

Save the project index file to a new location.

The project content is copied if pFlagCopyFiles is enabled The type of the project is kept the same (project folder enabled/disabled).

Parameters

pLocation	New location and name of the flprj file
pFlagCopyFiles	If enabled, external files and folders are copied to the new project location.
pFlagCopyFiles	If the project contains references to external files, they will be copied to the new project folder.

Extract the project to an from an archive,.

It will extract/overwrite the project files in the specified folder

Upgrade project to current version.

Upgrading a project might make it incompatible with earlier versions of the software. Some metadata definitions might not be useable with the current software version until the project is updated.

See also ProjectStorageManager::setAutoUpgradesEnabled(bool). If automatic upgrades are enabled in the project policy, the project is upgraded when it is read.

Reimplemented in ansys::Project::SimProject.