## On this page

  

 

 # SimBase

 Last update: 16.07.2025 

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

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

<a id="l00006" name="l00006"></a> 6 

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

<a id="l00008" name="l00008"></a> 8namespace Project {

<a id="l00009" name="l00009"></a> 9 

<a id="l00010" name="l00010"></a> 10class Metadata;

<a id="l00011" name="l00011"></a> 11 

<a id="l00012" name="l00012"></a>[ 12](classansys_1_1_project_1_1_sim_base.xhtml)class ANSYS_PROJECT_DLL [SimBase](classansys_1_1_project_1_1_sim_base.xhtml)

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

<a id="l00014" name="l00014"></a> 14public:

<a id="l00015" name="l00015"></a> 15 bool ok() const;

<a id="l00016" name="l00016"></a> 16 virtual [Error](classansys_1_1_project_1_1_error.xhtml) isValid() const = 0;

<a id="l00017" name="l00017"></a> 17 

<a id="l00018" name="l00018"></a> 18 std::string getName() const;

<a id="l00019" name="l00019"></a> 19 

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

<a id="l00021" name="l00021"></a> 21 virtual [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getCase() const;

<a id="l00022" name="l00022"></a> 22 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) setCase([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pCaseFile);

<a id="l00023" name="l00023"></a> 23 

<a id="l00024" name="l00024"></a> 24 void setMainDataType(const std::string&amp; pDataType);

<a id="l00025" name="l00025"></a> 25 std::string getMainDataType() const;

<a id="l00026" name="l00026"></a> 26 

<a id="l00027" name="l00027"></a> 27 // Inputs

<a id="l00028" name="l00028"></a> 28 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) copyInput([Path](classansys_1_1_project_1_1_path.xhtml) pPath,bool pInInputFolder=false);

<a id="l00029" name="l00029"></a> 29 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) setInput([Path](classansys_1_1_project_1_1_path.xhtml) pPath);

<a id="l00030" name="l00030"></a> 30 //Error importInput(URL pURL,std::string pName);

<a id="l00031" name="l00031"></a> 31 std::vector&lt;Iterator&gt; getInputs([Error](classansys_1_1_project_1_1_error.xhtml)* pErrorPtr=0) const;

<a id="l00032" name="l00032"></a> 32 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getInputByType(const std::string&amp; pType,std::string pSubtype="") const;

<a id="l00033" name="l00033"></a> 33 std::vector&lt;Iterator&gt; getInputsByType(const std::string&amp; pType,std::string pSubtype="",[Error](classansys_1_1_project_1_1_error.xhtml)* pErrorPtr=0) const;

<a id="l00034" name="l00034"></a> 34 

<a id="l00035" name="l00035"></a> 35 [Metadata](classansys_1_1_project_1_1_metadata.xhtml)&amp; getMeta();

<a id="l00036" name="l00036"></a> 36 const [Metadata](classansys_1_1_project_1_1_metadata.xhtml)&amp; getMeta() const;

<a id="l00037" name="l00037"></a> 37 

<a id="l00038" name="l00038"></a> 38 virtual [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getIterator() const;

<a id="l00039" name="l00039"></a> 39 operator [Iterator](classansys_1_1_project_1_1_iterator.xhtml)() const { return getIterator(); };

<a id="l00040" name="l00040"></a> 40 

<a id="l00041" name="l00041"></a> 41protected:

<a id="l00042" name="l00042"></a> 42 [SimBase](classansys_1_1_project_1_1_sim_base.xhtml)([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter);

<a id="l00043" name="l00043"></a> 43 virtual [~SimBase](classansys_1_1_project_1_1_sim_base.xhtml)() {};

<a id="l00044" name="l00044"></a> 44 

<a id="l00045" name="l00045"></a> 45 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) aIter;

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

<a id="l00047" name="l00047"></a> 47 // Utilities

<a id="l00048" name="l00048"></a> 48 [Error](classansys_1_1_project_1_1_error.xhtml) copyDatafileMeta(const [Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pInput,

<a id="l00049" name="l00049"></a> 49 [Iterator](classansys_1_1_project_1_1_iterator.xhtml)&amp; pOutput);

<a id="l00050" name="l00050"></a> 50};

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

<a id="l00052" name="l00052"></a> 52}

<a id="l00053" name="l00053"></a> 53}

<a id="l00054" name="l00054"></a> 54 

<a id="l00055" name="l00055"></a> 55\#endif // CFFSDK\_PROJECT\_SIMULATION\_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::Metadata](classansys_1_1_project_1_1_metadata.xhtml)

Dictionary of values associated with an Iterator.

**Definition:** Metadata.hpp:19



[ansys::Project::Path](classansys_1_1_project_1_1_path.xhtml)

Paths used for internal Project filesystem.

**Definition:** Path.hpp:11



[ansys::Project::SimBase](classansys_1_1_project_1_1_sim_base.xhtml)

Base class for Run and Simulation - shared functions.

**Definition:** SimBase.hpp:13



[ansys](namespaceansys.xhtml)

**Definition:** API.dox:1