ansys::Project::Iterator Class Reference

Error iterator constructor (ok() is false, error message provided)

Parameters

pError

Error message, will be returned by getError()

Execute a Query onto the current Iterator.

• pQuery Search query to be executed
• pFollowSymlink true if the query should go through links or ignore them

Returns

The list of Iterator matching the query, empty vector if none.

Folder - check if a child points to the specified URL.

Parameters

pRelativeURL

Relative URL from the folder location

Folder - return list of children Iterator of matching subclass.

Will also traverse subproject links automatically

Folder - return list of files in the folder URL, unknown by the project.

Only works if the folder URL is accessible.

Returns the Metadata for this project item.

The Metadata object can be modified and the changes will be stored in the project. If the iterator is not valid, any changes to the Metadata are ignored and lost.

Returns a constant reference to the Metadata for this project item.

The Metadata object cannot be modified If the iterator is not valid, the returned Metadata is empty

Return the iterator to the parent folder.

Returns null iterator in error, or the current iterator is the parent folder of the project already.

Return the item full Path in the project.

The Path in the project is a global path starting by / and identifying components by their project Name (the project Path might differ from the filesystem URL, or might refer to folders/files which only exist in the project index, and not on disk)

Return the unique project ID for this iterator.

Permits to check if an iterator is from a specific project. The project ID might differ across different executions.

Returns a reference to the runtime Metadata.

The runtime Metadata is a second Metadata storage, which contains values which are not saved in the project.

Return name of the subclass (if any) for the item.

See Simulation , Run , Output , Result , etc.

File/Folder - returns the URL pointed by this item.

See setURL(const URL&)

True if the -valid- pointed object is a File.

Checks if the iterator points to an item of the File type in the project index. It might be a project only file or an actual file on disk. See getURL() and urlExists()

True if the -valid- pointed object is a Folder.

Checks if the iterator points to an item of the Folder type in the project index. It might be a project only file or an actual file on disk. See getURL() and urlExists()

True if the -valid- pointed object is a Link.

Checks if the iterator points to an item of the Link type This is a project-level Link concept created by newLink()

Indicates if the target project or location is read-only.

All iterators of a read-only project are read-only, many iterator actions will have no effect or fail on a read-only project.

Link - Indicates if this is a link to a subproject.

If the link target is not ok() means the subproject is not loaded.

Indicates if the URL is ok to be modified by the user.

Two items affect this suggested state:

• URL are not editable by default is a managed project, are editable by default in a free-storage project
• The runtime metadata 'url-editable' can be set on the iterator, or any parent folder, to 0 or 1

Iterator - move from current folder to a target folder.

This is a project only operation, URL and disk data need to be udpated separately (Storage::moveFile())

Parameters

pTarget

Target folder to move to

Creates a new project-only file at this location in the project.

A project-only file is not created in the disk storage, its only stored in the project index. Will fail if : name already in use, target iterator is not a folder, read-only project, etc.

• pName Name of the new project file in project Path

Creates a new file associated with disk storage.

If pURL is empty, the existing URL name is assumed the same as the pName argument If pImport is enabled, the source URL is copied in the project folder

 it.newFile("main-case","file.cas");  // Refers to an existing or future file here
 it.newFile("demo.cas","/mnt/meshes/database.cas"); // file points to some location
 it.newFile("demo2.cas","/mnt/meshes/database.cas",true); // file is copied in folder

• pName Name of the new project file in project Path
• pURL URL of the file location
• pImport true if this is an import operation

Creates a new project-only folder at this location in the project.

A project-only folder is not created in the disk storage, its only stored in the project index. Will fail if : name already in use, target iterator is not a folder, read-only project, etc.

• pName Name of the new project folder in project Path

Creates a new folder associated with disk storage.

If URL is empty, and the project is managed, a new folder is created in the filesystem storage of the project.

 it.newFolder("CADs","");  // A new folder is created on disk, in the project
 it.newFolder("Meshes","/mnt/meshes/"); // folder points to some location

If the project is free-storage, an empty URL will create a project-only folder similar to newFolder(const std::string&);

• pName Name of the new project folder in project Path
• pURL URL of the folder location

True if the two iterators point to the same target.

Invalid/error iterator will always be unequal to another iterator

Folder - remove an item from the folder. Not erased from storage.

Parameters

pFlagRecursive

- true will erase a subfolder and its content

File/Folder - set the URL pointed by this item.

The URL can either be relative ( "./filename" ), and is then assumed to be in the enclosing folder URL. The URL can also be absolute, and is not tied to the location of the enclosing folder.