Skip to main content

Common Fluids Format 2023 R2

SimProject

Last update: 16.07.2025
1#ifndef CFFSDK_PROJECT_SIMPROJECT_H
2#define CFFSDK_PROJECT_SIMPROJECT_H
3
4#include "Project/LibraryType.hpp"
5#include "Project/Project.hpp"
6#include "Project/Iterator.hpp"
7
8namespace ansys {
9namespace Project {
10
11class ANSYS_PROJECT_DLL SimProject : public Project {
12public:
13
14 SimProject();
15 virtual ~SimProject();
16
17 Error importMesh(const URL& pURL,Iterator& pIter,std::string pName = "");
18 Iterator getMesh(const std::string& pName) const;
19 std::vector<std::string> getMeshes() const;
20
21 Error importGeometry(const URL& pURL,Iterator& pIter,std::string pName = "");
22 Iterator getGeometry(const std::string& pName) const;
23 std::vector<std::string> getGeometries() const;
24
25 Error importItem(const std::string& pCategory,const URL& pURL,Iterator& pIter,std::string pName = "");
26 Iterator getItem(const std::string& pCategory,const std::string& pName) const;
27 std::vector<std::string> getItems(const std::string& pCategory) const;
28
29 Iterator newSimulation(const std::string& pName,const std::string& pType);
30 Iterator getSimulation(const std::string& pName) const;
31 std::vector<std::string> getSimulations() const;
32 Error removeSimulation(const std::string& pName,bool pFlagErase);
33 Iterator duplicateSimulation(const std::string& pOld,
34 const std::string& pNew);
35
36 void setCurrentSimulation(Iterator pSim);
37 Iterator getCurrentSimulation() const;
38
39 virtual Error checkProject(CheckProjectInfo& pInfo) const;
40 virtual Error upgradeProject();
41 virtual Error copyMetadata(const Iterator& pSource,
42 Iterator& pTarget) const;
43
44 virtual Error getInheritedMetadata(const Iterator& pIter,
45 MetadataConst& pMeta);
46
47protected:
48 virtual Error updateFromPolicy();
49 virtual Error setupNewProject();
50 virtual Project* projectObjectFactory() const;
51
52private:
53 std::string aSimFolder;
54 std::string aSimPrefix;
55
56 std::string aRunFolder;
57 std::string aRunPrefix;
58};
59
60
61}
62}
63
64#endif // CFFSDK_PROJECT_SIMPROJECT_H
The return state / error value of a Project function call.
Definition: Error.hpp:11
Pointer to a project location.
Definition: Iterator.hpp:20
Constant (read-only) value of Metadata.
Definition: MetadataConst.hpp:23
Base class for Project API, also see SimProject.
Definition: Project.hpp:22
Main object for Simulation based projects.
Definition: SimProject.hpp:11
The address of a local or remote file, using the URI format.
Definition: URL.hpp:12
Definition: API.dox:1
Utility structure for VisitorCheckProject project checking action.
Definition: Project.hpp:98

Connect with Ansys