## On this page

  

 

 # SimProject

 Last update: 16.07.2025 

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

<a id="l00002" name="l00002"></a> 2\#define CFFSDK\_PROJECT\_SIMPROJECT\_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/Project.hpp"

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

<a id="l00007" name="l00007"></a> 7 

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

<a id="l00009" name="l00009"></a> 9namespace Project {

<a id="l00010" name="l00010"></a> 10 

<a id="l00011" name="l00011"></a>[ 11](classansys_1_1_project_1_1_sim_project.xhtml)class ANSYS_PROJECT_DLL [SimProject](classansys_1_1_project_1_1_sim_project.xhtml) : public [Project](classansys_1_1_project_1_1_project.xhtml) {

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

<a id="l00013" name="l00013"></a> 13 

<a id="l00014" name="l00014"></a> 14 [SimProject](classansys_1_1_project_1_1_sim_project.xhtml)();

<a id="l00015" name="l00015"></a> 15 virtual [~SimProject](classansys_1_1_project_1_1_sim_project.xhtml)();

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

<a id="l00017" name="l00017"></a> 17 [Error](classansys_1_1_project_1_1_error.xhtml) importMesh(const [URL](classansys_1_1_project_1_1_u_r_l.xhtml)&amp; pURL,[Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pIter,std::string pName = "");

<a id="l00018" name="l00018"></a> 18 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getMesh(const std::string&amp; pName) const;

<a id="l00019" name="l00019"></a> 19 std::vector&lt;std::string&gt; getMeshes() const;

<a id="l00020" name="l00020"></a> 20 

<a id="l00021" name="l00021"></a> 21 [Error](classansys_1_1_project_1_1_error.xhtml) importGeometry(const [URL](classansys_1_1_project_1_1_u_r_l.xhtml)&amp; pURL,[Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pIter,std::string pName = "");

<a id="l00022" name="l00022"></a> 22 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getGeometry(const std::string&amp; pName) const;

<a id="l00023" name="l00023"></a> 23 std::vector&lt;std::string&gt; getGeometries() const;

<a id="l00024" name="l00024"></a> 24 

<a id="l00025" name="l00025"></a> 25 [Error](classansys_1_1_project_1_1_error.xhtml) importItem(const std::string&amp; pCategory,const [URL](classansys_1_1_project_1_1_u_r_l.xhtml)&amp; pURL,[Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pIter,std::string pName = "");

<a id="l00026" name="l00026"></a> 26 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getItem(const std::string&amp; pCategory,const std::string&amp; pName) const;

<a id="l00027" name="l00027"></a> 27 std::vector&lt;std::string&gt; getItems(const std::string&amp; pCategory) const;

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

<a id="l00029" name="l00029"></a> 29 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) newSimulation(const std::string&amp; pName,const std::string&amp; pType);

<a id="l00030" name="l00030"></a> 30 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getSimulation(const std::string&amp; pName) const;

<a id="l00031" name="l00031"></a> 31 std::vector&lt;std::string&gt; getSimulations() const;

<a id="l00032" name="l00032"></a> 32 [Error](classansys_1_1_project_1_1_error.xhtml) removeSimulation(const std::string&amp; pName,bool pFlagErase);

<a id="l00033" name="l00033"></a> 33 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) duplicateSimulation(const std::string&amp; pOld,

<a id="l00034" name="l00034"></a> 34 const std::string&amp; pNew);

<a id="l00035" name="l00035"></a> 35 

<a id="l00036" name="l00036"></a> 36 void setCurrentSimulation([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pSim);

<a id="l00037" name="l00037"></a> 37 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getCurrentSimulation() const;

<a id="l00038" name="l00038"></a> 38 

<a id="l00039" name="l00039"></a> 39 virtual [Error](classansys_1_1_project_1_1_error.xhtml) checkProject([CheckProjectInfo](structansys_1_1_project_1_1_project_1_1_check_project_info.xhtml)&amp; pInfo) const;

<a id="l00040" name="l00040"></a> 40 virtual [Error](classansys_1_1_project_1_1_error.xhtml) upgradeProject();

<a id="l00041" name="l00041"></a> 41 virtual [Error](classansys_1_1_project_1_1_error.xhtml) copyMetadata(const [Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pSource,

<a id="l00042" name="l00042"></a> 42 [Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pTarget) const;

<a id="l00043" name="l00043"></a> 43 

<a id="l00044" name="l00044"></a> 44 virtual [Error](classansys_1_1_project_1_1_error.xhtml) getInheritedMetadata(const [Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pIter,

<a id="l00045" name="l00045"></a> 45 [MetadataConst](classansys_1_1_project_1_1_metadata_const.xhtml)&amp; pMeta);

<a id="l00046" name="l00046"></a> 46 

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

<a id="l00048" name="l00048"></a> 48 virtual [Error](classansys_1_1_project_1_1_error.xhtml) updateFromPolicy();

<a id="l00049" name="l00049"></a> 49 virtual [Error](classansys_1_1_project_1_1_error.xhtml) setupNewProject();

<a id="l00050" name="l00050"></a> 50 virtual [Project](classansys_1_1_project_1_1_project.xhtml)* projectObjectFactory() const;

<a id="l00051" name="l00051"></a> 51 

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

<a id="l00053" name="l00053"></a> 53 std::string aSimFolder;

<a id="l00054" name="l00054"></a> 54 std::string aSimPrefix;

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

<a id="l00056" name="l00056"></a> 56 std::string aRunFolder;

<a id="l00057" name="l00057"></a> 57 std::string aRunPrefix;

<a id="l00058" name="l00058"></a> 58};

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

<a id="l00060" name="l00060"></a> 60 

<a id="l00061" name="l00061"></a> 61}

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

<a id="l00063" name="l00063"></a> 63 

<a id="l00064" name="l00064"></a> 64\#endif // CFFSDK\_PROJECT\_SIMPROJECT\_H

[ansys::Project::Error](classansys_1_1_project_1_1_error.xhtml)

The return state / error value of a Project function call.

**Definition:** Error.hpp:11



[ansys::Project::Iterator](classansys_1_1_project_1_1_iterator.xhtml)

Pointer to a project location.

**Definition:** Iterator.hpp:20



[ansys::Project::MetadataConst](classansys_1_1_project_1_1_metadata_const.xhtml)

Constant (read-only) value of Metadata.

**Definition:** MetadataConst.hpp:23



[ansys::Project::Project](classansys_1_1_project_1_1_project.xhtml)

Base class for Project API, also see SimProject.

**Definition:** Project.hpp:22



[ansys::Project::SimProject](classansys_1_1_project_1_1_sim_project.xhtml)

Main object for Simulation based projects.

**Definition:** SimProject.hpp:11



[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



[ansys::Project::Project::CheckProjectInfo](structansys_1_1_project_1_1_project_1_1_check_project_info.xhtml)

Utility structure for VisitorCheckProject project checking action.

**Definition:** Project.hpp:98