Skip to main content

Common Fluids Format 2024 R1

Result

Last update: 16.07.2025
1#ifndef CFFSDK_PROJECT_RESULT_H
2#define CFFSDK_PROJECT_RESULT_H
3
4#include "Project/LibraryType.hpp"
5#include "Project/Iterator.hpp"
6#include "Project/RunOutputAttr.hpp"
7
8namespace ansys {
9namespace Project {
10
11class Metadata;
12
13class ANSYS_PROJECT_DLL Result : public RunOutputAttr
14{
15public:
16 Result(Iterator pIter);
17 virtual ~Result() {};
18
19 bool ok() const;
20 virtual Error isValid() const;
21
22 Iterator getCase() const;
23 void setCase(Iterator pCase);
24 Iterator getInputByType(const std::string& pType,const std::string& pSubtype) const;
25
26 // Metadata with inheritance
27 virtual bool hasValue(const std::string& pVar,bool pFlagInherited) const;
28 Iterator getValueIter(const std::string& pVar) const;
29
30 virtual std::string getValue(const std::string& pVar,bool pFlagInherited) const;
31 virtual int getValueInt(const std::string& pVar,bool pFlagInherited) const;
32 virtual double getValueDouble(const std::string& pVar,bool pFlagInherited) const;
33 virtual MetaVariableType getValueType(const std::string& pVar,bool pFlagInherited) const;
34 virtual void setValue(const std::string& pVar,const std::string& pValue);
35 virtual void setValueInt(const std::string& pVar,int pValue);
36 virtual void setValueDouble(const std::string& pVar,double pValue);
37
38 // backward compatibility api
39 void setValue(const std::string& pVar,int pValue) { setValueInt(pVar,pValue); };
40 void setValue(const std::string& pVar,double pValue) { setValueDouble(pVar,pValue); };
41
42 // See RunOutputAttributes for convenience APIs (getIndex,getSolverIteration,getTime, etc.)
43
44 Iterator getIterator() const;
45 operator Iterator() const { return getIterator(); };
46
47protected:
48 Iterator aIter;
49};
50
51}
52}
53
54#endif // CFFSDK_PROJECT_RESULT_H
The return state / error value of a Project function call.
Definition: Error.hpp:11
Pointer to a project location.
Definition: Iterator.hpp:20
Result (data) file, output of a Simulation Run.
Definition: Result.hpp:14
Base class for Run, Output, Result - provide built-in variable set/get functions.
Definition: RunOutputAttr.hpp:13
Definition: API.dox:1

Connect with Ansys