## On this page

  

 

 # ansys::Project::Output Class Reference

 Last update: 16.07.2025 

Subfolder of a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), regrouping Results for a step. [More...](classansys_1_1_project_1_1_output.xhtml#details)

`#include "<a class="el" href="_output_8hpp_source.xhtml">Output.hpp</a>"`

Inheritance diagram for ansys::Project::Output:

 ![](/sites/default/files/migrate-content/common_fluids_format_/classansys_1_1_project_1_1_output.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Output](classansys_1_1_project_1_1_output.xhtml#a5822cd96f3da57e907ee6f6659c5335c) ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter) Constructor from [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").   
[More...](classansys_1_1_project_1_1_output.xhtml#a5822cd96f3da57e907ee6f6659c5335c)  
 <a id="a58c220b2e403a6e756aaf9e0c163b6ba" name="a58c220b2e403a6e756aaf9e0c163b6ba"></a>bool **ok** () const Indicates if the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") is valid and of correct subclass.   
 <a id="a2a38e88d319574a635ce859eb73919a5" name="a2a38e88d319574a635ce859eb73919a5"></a>virtual [Error](classansys_1_1_project_1_1_error.xhtml) **isValid** () const Returns error with message if invalid.   
 <a id="a93d33e0bc884192ab2aa879ad0eebdff" name="a93d33e0bc884192ab2aa879ad0eebdff"></a>void **setCase** ([Iterator](classansys_1_1_project_1_1_iterator.xhtml) pIter) Assign the case used/shared by results of this output, as link.   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getCase](classansys_1_1_project_1_1_output.xhtml#a4cdd2bb59681158e7bb39e82508a4f29) () const Return the case link, if any. [More...](classansys_1_1_project_1_1_output.xhtml#a4cdd2bb59681158e7bb39e82508a4f29)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getInputByType](classansys_1_1_project_1_1_output.xhtml#adb5e10045807b888a6db4bc959f225b3) (const std::string &amp;pType) const Search the metadata links for the specified file type. [More...](classansys_1_1_project_1_1_output.xhtml#adb5e10045807b888a6db4bc959f225b3)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [newResult](classansys_1_1_project_1_1_output.xhtml#afec42193db909a825ab770038910dfbb) (const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;pFileLocation, const std::string &amp;pName, const std::string &amp;pType, const std::string &amp;pSubtype) Create a [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") object in the current [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder. [More...](classansys_1_1_project_1_1_output.xhtml#afec42193db909a825ab770038910dfbb)  
 <a id="a04438a90a5d193ae7fdb837a9ecefb6d" name="a04438a90a5d193ae7fdb837a9ecefb6d"></a>std::vector&lt; [Iterator](classansys_1_1_project_1_1_iterator.xhtml) &gt; **getResultIterators** (const std::string &amp;pType, const std::string &amp;pSubtype) const Return the list of results in the current [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), as a vector of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").   
 <a id="aca5783bffbd5016ababb82e365746f0d" name="aca5783bffbd5016ababb82e365746f0d"></a>std::vector&lt; [Result](classansys_1_1_project_1_1_result.xhtml) &gt; **getResults** (const std::string &amp;pType, const std::string &amp;pSubtype) const Return the list of results in the current [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), as a vector of [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.").   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getData](classansys_1_1_project_1_1_output.xhtml#afec1dc4d84b3faaba2a23724a632e1f8) () Returns the main data file for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). [More...](classansys_1_1_project_1_1_output.xhtml#afec1dc4d84b3faaba2a23724a632e1f8)  
 <a id="ae00d3ebda857978204a8565849f1bb61" name="ae00d3ebda857978204a8565849f1bb61"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getResult** (const std::string &amp;pDataType) Returns the enclosed [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") with the specified subtype.   
 virtual bool [hasValue](classansys_1_1_project_1_1_output.xhtml#aee14eecc689169da3b4a4ac4a31e465c) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key. [More...](classansys_1_1_project_1_1_output.xhtml#aee14eecc689169da3b4a4ac4a31e465c)  
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getValueIter](classansys_1_1_project_1_1_output.xhtml#a4d0eab10bab90999b734d237c9975f5d) (const std::string &amp;pVar) const Search the metadata (local and inherited) for the specified metadata link and return the value as an iterator. [More...](classansys_1_1_project_1_1_output.xhtml#a4d0eab10bab90999b734d237c9975f5d)  
 virtual std::string [getValue](classansys_1_1_project_1_1_output.xhtml#a8f8a26e4aa49305a5641b1f6a77ed6bb) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as string. [More...](classansys_1_1_project_1_1_output.xhtml#a8f8a26e4aa49305a5641b1f6a77ed6bb)  
 virtual int [getValueInt](classansys_1_1_project_1_1_output.xhtml#a0faaaf36081aefb020559194ce3ced49) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as integer. [More...](classansys_1_1_project_1_1_output.xhtml#a0faaaf36081aefb020559194ce3ced49)  
 virtual double [getValueDouble](classansys_1_1_project_1_1_output.xhtml#a947704ae972aebe9a812a615e3d305b8) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the value as double. [More...](classansys_1_1_project_1_1_output.xhtml#a947704ae972aebe9a812a615e3d305b8)  
 virtual MetaVariableType [getValueType](classansys_1_1_project_1_1_output.xhtml#a4d54e20f739de356a83415d5e5adce0e) (const std::string &amp;pVar, bool pFlagInherited) const Search the metadata (local and inherited) for the specified key and return the its data type. [More...](classansys_1_1_project_1_1_output.xhtml#a4d54e20f739de356a83415d5e5adce0e)  
 <a id="ab69eb9e316781111bb8eadcbd275f46a" name="ab69eb9e316781111bb8eadcbd275f46a"></a>virtual void **setValue** (const std::string &amp;pVar, const std::string &amp;pValue) Sets the local metadata to the specified key/value.   
 <a id="a653c0e8ffd12694cc984519c2389dfd7" name="a653c0e8ffd12694cc984519c2389dfd7"></a>virtual void **setValueInt** (const std::string &amp;pVar, int pValue) Sets the local metadata to the specified key/value.   
 <a id="a6a388a3ce8f6b19b24f10915b35a5c5a" name="a6a388a3ce8f6b19b24f10915b35a5c5a"></a>virtual void **setValueDouble** (const std::string &amp;pVar, double pValue) Sets the local metadata to the specified key/value.   
 <a id="a0d1045bc40cbe9d3ee001e1f226f351c" name="a0d1045bc40cbe9d3ee001e1f226f351c"></a>void **setTransparent** (bool pHide) Set the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") visible or invisible (transparent) in the project viewer.   
 <a id="a16c0aa2eb60649962e8174ff139057ae" name="a16c0aa2eb60649962e8174ff139057ae"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getIterator** () const Returns the [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.").   
 void [setRunStatus](classansys_1_1_project_1_1_output.xhtml#a424c139480241d171fc63c81640b0e62) (RunStatus pStatus) Set the RunStatus state for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). [More...](classansys_1_1_project_1_1_output.xhtml#a424c139480241d171fc63c81640b0e62)  
 <a id="aa65dedbfd1d5f5ac7b11aafbd20652f1" name="aa65dedbfd1d5f5ac7b11aafbd20652f1"></a>RunStatus **getRunStatus** () const Returns the RunStatus state for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."). See [setRunStatus()](classansys_1_1_project_1_1_output.xhtml#a424c139480241d171fc63c81640b0e62 "Set the RunStatus state for this Output.")   
 ![-](/sites/default/files/migrate-content/common_fluids_format_/closed.png) Public Member Functions inherited from [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml)<a id="a3552775077206a3eb84c63548b1dce8f" name="a3552775077206a3eb84c63548b1dce8f"></a>std::vector&lt; std::string &gt; **getValues** (const std::vector&lt; std::string &gt; &amp;pVars, bool pFlagInherited) const Returns the values for a list of variables.   
 <a id="afd9f573f991216d001360be85a476827" name="afd9f573f991216d001360be85a476827"></a>int **getIndex** () const Returns the output index (incremental id in a run) - always available.   
 <a id="a9341f80aeb8c06eae7405815daabc2de" name="a9341f80aeb8c06eae7405815daabc2de"></a>int **getSolverIteration** () const Returns the number of solver iterations (if available)   
 <a id="a43a2d325edb0332bd89dd279da60de88" name="a43a2d325edb0332bd89dd279da60de88"></a>double **getTime** () const Returns the transient time value (if available)   
 <a id="a8e79b641bdf6cd9fa3132839b2314cfa" name="a8e79b641bdf6cd9fa3132839b2314cfa"></a>void **setIndex** (int pValue) Changes the specified variable.   
 <a id="a5aef7a029fa3a7f830710275035c4bae" name="a5aef7a029fa3a7f830710275035c4bae"></a>void **setSolverIteration** (int pValue) Changes the specified variable.   
 <a id="a7223a840d264a500994bc1a424772c19" name="a7223a840d264a500994bc1a424772c19"></a>void **setTime** (double pValue) Changes the specified variable.   
 <a id="a2722c5a61bdf6ae862f77277cb799dae" name="a2722c5a61bdf6ae862f77277cb799dae"></a>double **getCrankAngle** () const Returns the specified variable (if available)   
 <a id="a399cfa854a08df9c39ed9c7324651012" name="a399cfa854a08df9c39ed9c7324651012"></a>void **setCrankAngle** (double pValue) Changes the specified variable.   
 <a id="a3c9c4e3b8a1901e526c252b9beda9580" name="a3c9c4e3b8a1901e526c252b9beda9580"></a>int **getCaseId** () const Returns the specified variable (if available)   
 int [getInputSettingsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a267138500fe47e1c74adebc0b3b3082e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a267138500fe47e1c74adebc0b3b3082e)  
 int [getDomainTransformationId](classansys_1_1_project_1_1_run_output_attr.xhtml#ae1427ae2518b3bf20a72183388307d4e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#ae1427ae2518b3bf20a72183388307d4e)  
 int [getPhysicsId](classansys_1_1_project_1_1_run_output_attr.xhtml#a212e33422926cc6ce0c06ee08b301f83) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a212e33422926cc6ce0c06ee08b301f83)  
 <a id="a5b718ea67c8d4abcec38f3968ffe71f6" name="a5b718ea67c8d4abcec38f3968ffe71f6"></a>int **getOutputSettingsId** () const Returns the specified variable (if available)   
 <a id="a9b573f92ba0532e9af0181634727d876" name="a9b573f92ba0532e9af0181634727d876"></a>int **getMeshId** () const Returns the specified variable (if available)   
 int [getTopologyId](classansys_1_1_project_1_1_run_output_attr.xhtml#a2088deca6c0239248d5c7d1d81b6c3a3) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a2088deca6c0239248d5c7d1d81b6c3a3)  
 int [getConnectivityId](classansys_1_1_project_1_1_run_output_attr.xhtml#aef3b9200f5924db3428e31e0c8c6e80e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#aef3b9200f5924db3428e31e0c8c6e80e)  
 int [getCoordinatesId](classansys_1_1_project_1_1_run_output_attr.xhtml#a3a414dbc11513402e17c2eafaf240e7e) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a3a414dbc11513402e17c2eafaf240e7e)  
 int [getLocationId](classansys_1_1_project_1_1_run_output_attr.xhtml#a5d22709f5cd0500b1c0e5db416f1b8e4) () const Returns the specified variable (if available) [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a5d22709f5cd0500b1c0e5db416f1b8e4)  
 <a id="a98234a96286c594c628ae5fc66a2daf1" name="a98234a96286c594c628ae5fc66a2daf1"></a>void **setCaseId** (int pValue) Changes the specified variable.   
 <a id="a4dc9c1c940983005c8aa55516c7dd370" name="a4dc9c1c940983005c8aa55516c7dd370"></a>void **setInputSettingsId** (int pValue) Changes the specified variable.   
 <a id="a48ce611d3011e8d85c7508654d10b0b7" name="a48ce611d3011e8d85c7508654d10b0b7"></a>void **setDomainTransformationId** (int pValue) Changes the specified variable.   
 <a id="a144923c544b7f9e25adaa02c4d0fcfb2" name="a144923c544b7f9e25adaa02c4d0fcfb2"></a>void **setPhysicsId** (int pValue) Changes the specified variable.   
 <a id="aff075987d634ddd1bb5cc72885e60476" name="aff075987d634ddd1bb5cc72885e60476"></a>void **setOutputSettingsId** (int pValue) Changes the specified variable.   
 <a id="af6651bd327bccc3154c7a9dff550b780" name="af6651bd327bccc3154c7a9dff550b780"></a>void **setMeshId** (int pValue) Changes the specified variable.   
 <a id="a8952ac3fb7b31862798fef375a37f789" name="a8952ac3fb7b31862798fef375a37f789"></a>void **setTopologyId** (int pValue) Changes the specified variable.   
 <a id="a2e8201893b1ffef4e96758118ac1438c" name="a2e8201893b1ffef4e96758118ac1438c"></a>void **setConnectivityId** (int pValue) Changes the specified variable.   
 <a id="a1f1a501898b6eaf181ef0b3b7a991342" name="a1f1a501898b6eaf181ef0b3b7a991342"></a>void **setCoordinatesId** (int pValue) Changes the specified variable.   
 <a id="ad49c7e9e12f20d93598d744d8c419f5c" name="ad49c7e9e12f20d93598d744d8c419f5c"></a>void **setLocationId** (int pValue) Changes the specified variable.   
 <a id="a47b791d288a9af06d565d5bacd1dd612" name="a47b791d288a9af06d565d5bacd1dd612"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentCaseId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a05cad22c19d74259c554f2f0dc86305a" name="a05cad22c19d74259c554f2f0dc86305a"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentPhysicsId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a67d0800d2ce78055bcd9658b1ea30136" name="a67d0800d2ce78055bcd9658b1ea30136"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentInputSettingsId** () const See getFirstIterator(const std::string&amp;)   
 <a id="adbcf15409dbcf5051cc8fcb3afdf930f" name="adbcf15409dbcf5051cc8fcb3afdf930f"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentDomainTransformationId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a808bda2819d90363f4914bc637969154" name="a808bda2819d90363f4914bc637969154"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentMeshId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a3f53d6fb39644ef6a923d2d79baa0d12" name="a3f53d6fb39644ef6a923d2d79baa0d12"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentTopologyId** () const See getFirstIterator(const std::string&amp;)   
 <a id="ad4aecfe2ed99b6e81a24edcc8699aa42" name="ad4aecfe2ed99b6e81a24edcc8699aa42"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentConnectivityId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a2badf834ba45aa1be083272d66e68cb8" name="a2badf834ba45aa1be083272d66e68cb8"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentCoordinatesId** () const See getFirstIterator(const std::string&amp;)   
 <a id="a9c43c27adee9503eed4f3940ded66ac7" name="a9c43c27adee9503eed4f3940ded66ac7"></a>[Iterator](classansys_1_1_project_1_1_iterator.xhtml) **getFirstIteratorForCurrentLocationId** () const See getFirstIterator(const std::string&amp;)   
 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) [getFirstIteratorForCurrent](classansys_1_1_project_1_1_run_output_attr.xhtml#a992b28250638dc51bde6fc49ea336ab4) (const std::string &amp;pVar) const Return the first entry in the current [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), with same variable value. [More...](classansys_1_1_project_1_1_run_output_attr.xhtml#a992b28250638dc51bde6fc49ea336ab4)  
 <a id="details" name="details"></a>## Detailed Description

Subfolder of a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), regrouping Results for a step.

In a [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step."), one or multiple [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") are to be created, to store the results. Depending of the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") type (transient, parametric, steady...) the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") will have Metatada assigned accordinly (time step, variable value, iteration, etc.)

Subclass of [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."), can be constructed from an [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location."), the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") is [ok()](classansys_1_1_project_1_1_output.xhtml#a58c220b2e403a6e756aaf9e0c163b6ba "Indicates if the Iterator is valid and of correct subclass.") only if the provided iterator is of the appropriate subclass.

```
  Iterator it = prj.get("/Sim1/Run1/out1/");
  Output out(it);
    out.ok()
```

 The [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") regroups a set of Results in a subfolder (can be project-only and not a true folder in the storage filesystem) [Metadata](classansys_1_1_project_1_1_metadata.xhtml "Dictionary of values associated with an Iterator.") attributes assigned to the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") will be inherited by all underlying Results.

Sample workflow, for transient

```
 Output o = run.newOutput("")
 o.setTime(0.);
 o.newResult("out.00000001.dat","","Result","fluent-dat");
 o = run.newOutput("")
 o.setTime(0.1);
 o.newResult("out.00000002.dat","","Result","fluent-dat");
```



## Constructor &amp; Destructor Documentation

<a id="a5822cd96f3da57e907ee6f6659c5335c" name="a5822cd96f3da57e907ee6f6659c5335c"></a>## [◆ ](#a5822cd96f3da57e907ee6f6659c5335c)Output()

 ansys::Project::Output::Output  ( [Iterator](classansys_1_1_project_1_1_iterator.xhtml)  *pIter*) 

Constructor from [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.").

The input [Iterator](classansys_1_1_project_1_1_iterator.xhtml "Pointer to a project location.") must be of subclass [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") If the subclass is not [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step."), the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") object is invalid ( !ok() )





## Member Function Documentation

<a id="a4cdd2bb59681158e7bb39e82508a4f29" name="a4cdd2bb59681158e7bb39e82508a4f29"></a>## [◆ ](#a4cdd2bb59681158e7bb39e82508a4f29)getCase()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Output::getCase  ( )  const

Return the case link, if any.

If not defined at this level, the parent [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") or [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") are searched for such a Case link.





<a id="afec1dc4d84b3faaba2a23724a632e1f8" name="afec1dc4d84b3faaba2a23724a632e1f8"></a>## [◆ ](#afec1dc4d84b3faaba2a23724a632e1f8)getData()

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

Returns the main data file for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.").

The main data file is registered at the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") or [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") level, as the [SimBase::setMainDataType(const std::string&amp;)](classansys_1_1_project_1_1_sim_base.xhtml#ac44fe199d4f2c2c7aa8be5d22353740a "Set the result type expected as default output for runs."), the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder is searched for a [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") matching this type.





<a id="adb5e10045807b888a6db4bc959f225b3" name="adb5e10045807b888a6db4bc959f225b3"></a>## [◆ ](#adb5e10045807b888a6db4bc959f225b3)getInputByType()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Output::getInputByType  ( const std::string &amp;  *pType*)  const

Search the metadata links for the specified file type.

Links are stored in [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") as metadata, in [Simulation](classansys_1_1_project_1_1_simulation.xhtml "Subfolder of a Project, regrouping input files and Run subfolders.") and [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") they are stored as an Input/ subfolder entry





<a id="a8f8a26e4aa49305a5641b1f6a77ed6bb" name="a8f8a26e4aa49305a5641b1f6a77ed6bb"></a>## [◆ ](#a8f8a26e4aa49305a5641b1f6a77ed6bb)getValue()

 std::string ansys::Project::Output::getValue  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as string.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a947704ae972aebe9a812a615e3d305b8" name="a947704ae972aebe9a812a615e3d305b8"></a>## [◆ ](#a947704ae972aebe9a812a615e3d305b8)getValueDouble()

 double ansys::Project::Output::getValueDouble  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as double.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a0faaaf36081aefb020559194ce3ced49" name="a0faaaf36081aefb020559194ce3ced49"></a>## [◆ ](#a0faaaf36081aefb020559194ce3ced49)getValueInt()

 int ansys::Project::Output::getValueInt  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the value as integer.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="a4d0eab10bab90999b734d237c9975f5d" name="a4d0eab10bab90999b734d237c9975f5d"></a>## [◆ ](#a4d0eab10bab90999b734d237c9975f5d)getValueIter()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Output::getValueIter  ( const std::string &amp;  *pVar*)  const

Search the metadata (local and inherited) for the specified metadata link and return the value as an iterator.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally 



<a id="a4d54e20f739de356a83415d5e5adce0e" name="a4d54e20f739de356a83415d5e5adce0e"></a>## [◆ ](#a4d54e20f739de356a83415d5e5adce0e)getValueType()

 MetaVariableType ansys::Project::Output::getValueType  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key and return the its data type.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="aee14eecc689169da3b4a4ac4a31e465c" name="aee14eecc689169da3b4a4ac4a31e465c"></a>## [◆ ](#aee14eecc689169da3b4a4ac4a31e465c)hasValue()

 bool ansys::Project::Output::hasValue  ( const std::string &amp;  *pVar*,    bool  *pFlagInherited*   )  const  virtual 

Search the metadata (local and inherited) for the specified key.

Parameters pFlagInherited: If true, the parent Run/Simulation are searched for the metadata entry, if not defined locally Implements [ansys::Project::RunOutputAttr](classansys_1_1_project_1_1_run_output_attr.xhtml).





<a id="afec42193db909a825ab770038910dfbb" name="afec42193db909a825ab770038910dfbb"></a>## [◆ ](#afec42193db909a825ab770038910dfbb)newResult()

 [Iterator](classansys_1_1_project_1_1_iterator.xhtml) ansys::Project::Output::newResult  ( const [URL](classansys_1_1_project_1_1_u_r_l.xhtml) &amp;  *pFileLocation*,    const std::string &amp;  *pName*,    const std::string &amp;  *pType*,    const std::string &amp;  *pSubtype*   ) 

Create a [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") object in the current [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder.

The newResult operation creates a file reference to a specified [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.")

Parameters pFileLocation: [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") of the [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") file, if a relative path it is assumed to be created in the [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") folder location (typically the [Run](classansys_1_1_project_1_1_run.xhtml "Subfolder of a Simulation, regrouping Output/Result for a step.") folder) pName: Name of the project file, use "" to use same name as the [URL](classansys_1_1_project_1_1_u_r_l.xhtml "The address of a local or remote file, using the URI format.") filename pType: Type of the file, typically: [Result](classansys_1_1_project_1_1_result.xhtml "Result (data) file, output of a Simulation Run.") or Case will be stored in the DataType metadata entry pSubType: Format specifier for the file type, for example fluent-dat , fsp-soln will be stored in the {pType}Type metadata entry 



<a id="a424c139480241d171fc63c81640b0e62" name="a424c139480241d171fc63c81640b0e62"></a>## [◆ ](#a424c139480241d171fc63c81640b0e62)setRunStatus()

 void ansys::Project::Output::setRunStatus  ( RunStatus  *pStatus*) 

Set the RunStatus state for this [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.").

(Optional API) The run status permits to indicate if a specific [Output](classansys_1_1_project_1_1_output.xhtml "Subfolder of a Run, regrouping Results for a step.") is running, completed, waiting for execution, etc.