Skip to main content

Common Fluids Format 2023 R2

Output

Last update: 16.07.2025
1#ifndef CFFSDK_PROJECT_OUTPUT_H
2#define CFFSDK_PROJECT_OUTPUT_H
3
4#include "Project/LibraryType.hpp"
5#include "Project/Iterator.hpp"
6#include "Project/SimBase.hpp"
7#include "Project/Result.hpp"
8#include "Project/RunOutputAttr.hpp"
9#include "Project/Types.hpp"
10
11namespace ansys {
12namespace Project {
13
14class Metadata;
15
16class ANSYS_PROJECT_DLL Output : public RunOutputAttr
17{
18public:
19 Output(Iterator pIter);
20 virtual ~Output() {};
21
22 bool ok() const;
23 virtual Error isValid() const;
24
25 bool operator==(const Output& pObj) const {
26 return getIterator() == pObj.getIterator();
27 }
28 bool operator!=(const Output& pObj) const {
29 return !(*this == pObj);
30 }
31
32 void setCase(Iterator pIter);
33 Iterator getCase() const;
34 Iterator getInputByType(const std::string& pType) const;
35
36 Iterator newResult(const URL& pFileLocation,
37 const std::string& pName,
38 const std::string& pType,
39 const std::string& pSubtype);
40 std::vector<Iterator> getResultIterators( const std::string& pType,
41 const std::string& pSubtype ) const;
42 std::vector<Result> getResults( const std::string& pType,
43 const std::string& pSubtype ) const;
44
45 // Shorthand for single result
46 Iterator getData();
47 Iterator getResult(const std::string& pDataType);
48
49 // Metadata with inheritance
50 virtual bool hasValue(const std::string& pVar,bool pFlagInherited) const;
51 Iterator getValueIter(const std::string& pVar) const;
52
53 virtual std::string getValue(const std::string& pVar,bool pFlagInherited) const;
54 virtual int getValueInt(const std::string& pVar,bool pFlagInherited) const;
55 virtual double getValueDouble(const std::string& pVar,bool pFlagInherited) const;
56 virtual MetaVariableType getValueType(const std::string& pVar,bool pFlagInherited) const;
57 virtual void setValue(const std::string& pVar,const std::string& pValue);
58 virtual void setValueInt(const std::string& pVar,int pValue);
59 virtual void setValueDouble(const std::string& pVar,double pValue);
60
61 // backward compatibility api
62 void setValue(const std::string& pVar,int pValue) { setValueInt(pVar,pValue); };
63 void setValue(const std::string& pVar,double pValue) { setValueDouble(pVar,pValue); };
64
65 void setTransparent(bool pHide);
66
67 Iterator getIterator() const;
68 operator Iterator() const { return getIterator(); };
69
70 void setRunStatus(RunStatus pStatus);
71 RunStatus getRunStatus() const;
72
73protected:
74
75 Iterator aIter;
76};
77
78}
79}
80
81#endif // CFFSDK_PROJECT_OUTPUT_H
The return state / error value of a Project function call.
Definition: Error.hpp:11
Pointer to a project location.
Definition: Iterator.hpp:20
Subfolder of a Run, regrouping Results for a step.
Definition: Output.hpp:17
Iterator getIterator() const
Returns the Iterator for this Output.
Definition: Output.cpp:306
Base class for Run, Output, Result - provide built-in variable set/get functions.
Definition: RunOutputAttr.hpp:13
The address of a local or remote file, using the URI format.
Definition: URL.hpp:12
Definition: API.dox:1

Connect with Ansys