## On this page

  

 

 # Output

 Last update: 16.07.2025 

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

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

<a id="l00007" name="l00007"></a> 7\#include "Project/Result.hpp"

<a id="l00008" name="l00008"></a> 8\#include "Project/RunOutputAttr.hpp"

<a id="l00009" name="l00009"></a> 9\#include "Project/Types.hpp"

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

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

<a id="l00012" name="l00012"></a> 12namespace Project {

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

<a id="l00014" name="l00014"></a> 14class Metadata;

<a id="l00015" name="l00015"></a> 15 

<a id="l00016" name="l00016"></a>[ 16](classansys_1_1_project_1_1_output.xhtml)class ANSYS_PROJECT_DLL [Output](classansys_1_1_project_1_1_output.xhtml) : public [RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)

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

<a id="l00018" name="l00018"></a> 18public:

<a id="l00019" name="l00019"></a> 19 [Output](classansys_1_1_project_1_1_output.xhtml)([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter);

<a id="l00020" name="l00020"></a> 20 virtual [~Output](classansys_1_1_project_1_1_output.xhtml)() {};

<a id="l00021" name="l00021"></a> 21 

<a id="l00022" name="l00022"></a> 22 bool ok() const;

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

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

<a id="l00025" name="l00025"></a> 25 bool operator==(const [Output](classansys_1_1_project_1_1_output.xhtml)&amp; pObj) const {

<a id="l00026" name="l00026"></a> 26 return getIterator() == pObj.[getIterator](classansys_1_1_project_1_1_output.xhtml#a16c0aa2eb60649962e8174ff139057ae)();

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

<a id="l00028" name="l00028"></a> 28 bool operator!=(const [Output](classansys_1_1_project_1_1_output.xhtml)&amp; pObj) const {

<a id="l00029" name="l00029"></a> 29 return !(*this == pObj);

<a id="l00030" name="l00030"></a> 30 }

<a id="l00031" name="l00031"></a> 31 

<a id="l00032" name="l00032"></a> 32 void setCase([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter);

<a id="l00033" name="l00033"></a> 33 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getCase() const;

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

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

<a id="l00036" name="l00036"></a> 36 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) newResult(const [URL](classansys_1_1_project_1_1_u_r_l.xhtml)&amp; pFileLocation,

<a id="l00037" name="l00037"></a> 37 const std::string&amp; pName,

<a id="l00038" name="l00038"></a> 38 const std::string&amp; pType,

<a id="l00039" name="l00039"></a> 39 const std::string&amp; pSubtype);

<a id="l00040" name="l00040"></a> 40 std::vector&lt;Iterator&gt; getResultIterators( const std::string&amp; pType,

<a id="l00041" name="l00041"></a> 41 const std::string&amp; pSubtype ) const;

<a id="l00042" name="l00042"></a> 42 std::vector&lt;Result&gt; getResults( const std::string&amp; pType,

<a id="l00043" name="l00043"></a> 43 const std::string&amp; pSubtype ) const;

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

<a id="l00045" name="l00045"></a> 45 // Shorthand for single result

<a id="l00046" name="l00046"></a> 46 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getData();

<a id="l00047" name="l00047"></a> 47 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getResult(const std::string&amp; pDataType);

<a id="l00048" name="l00048"></a> 48 

<a id="l00049" name="l00049"></a> 49 // Metadata with inheritance

<a id="l00050" name="l00050"></a> 50 virtual bool hasValue(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00051" name="l00051"></a> 51 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getValueIter(const std::string&amp; pVar) const;

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

<a id="l00053" name="l00053"></a> 53 virtual std::string getValue(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00054" name="l00054"></a> 54 virtual int getValueInt(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00055" name="l00055"></a> 55 virtual double getValueDouble(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00056" name="l00056"></a> 56 virtual MetaVariableType getValueType(const std::string&amp; pVar,bool pFlagInherited) const;

<a id="l00057" name="l00057"></a> 57 virtual void setValue(const std::string&amp; pVar,const std::string&amp; pValue);

<a id="l00058" name="l00058"></a> 58 virtual void setValueInt(const std::string&amp; pVar,int pValue);

<a id="l00059" name="l00059"></a> 59 virtual void setValueDouble(const std::string&amp; pVar,double pValue);

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

<a id="l00061" name="l00061"></a> 61 // backward compatibility api

<a id="l00062" name="l00062"></a> 62 void setValue(const std::string&amp; pVar,int pValue) { setValueInt(pVar,pValue); };

<a id="l00063" name="l00063"></a> 63 void setValue(const std::string&amp; pVar,double pValue) { setValueDouble(pVar,pValue); };

<a id="l00064" name="l00064"></a> 64 

<a id="l00065" name="l00065"></a> 65 void setTransparent(bool pHide);

<a id="l00066" name="l00066"></a> 66 

<a id="l00067" name="l00067"></a> 67 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) getIterator() const;

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

<a id="l00069" name="l00069"></a> 69 

<a id="l00070" name="l00070"></a> 70 void setRunStatus(RunStatus pStatus);

<a id="l00071" name="l00071"></a> 71 RunStatus getRunStatus() const;

<a id="l00072" name="l00072"></a> 72 

<a id="l00073" name="l00073"></a> 73protected:

<a id="l00074" name="l00074"></a> 74 

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

<a id="l00076" name="l00076"></a> 76};

<a id="l00077" name="l00077"></a> 77 

<a id="l00078" name="l00078"></a> 78}

<a id="l00079" name="l00079"></a> 79}

<a id="l00080" name="l00080"></a> 80 

<a id="l00081" name="l00081"></a> 81\#endif // CFFSDK\_PROJECT\_OUTPUT\_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::Output](classansys_1_1_project_1_1_output.xhtml)

Subfolder of a Run, regrouping Results for a step.

**Definition:** Output.hpp:17



[ansys::Project::Output::getIterator](classansys_1_1_project_1_1_output.xhtml#a16c0aa2eb60649962e8174ff139057ae)

Iterator getIterator() const

Returns the Iterator for this Output.

**Definition:** Output.cpp:306



[ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)

Base class for Run, Output, Result - provide built-in variable set/get functions.

**Definition:** RunOutputAttr.hpp:13



[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