Skip to main content

Common Fluids Format 2023 R2

CffFileConsumer

Last update: 16.07.2025
1/*
2 * Copyright ANSYS. All Rights Reserved.
3 */
4
5#ifndef CFFINTERFACE_CFFINTERFACE_CFFFILECONSUMER_HPP_
6#define CFFINTERFACE_CFFINTERFACE_CFFFILECONSUMER_HPP_
7
8#include "LibraryType.hpp"
9#include "CffConsumer.hpp"
10#include "CffFileIO.hpp"
11
12#include "Types.hpp"
13
14namespace ansys {
15
16class ANSYS_FLUIDS_CFFINTERFACE_DLL CffFileConsumer
17 : public CffConsumer, public CffFileIO
18{
19 public:
20 virtual ~CffFileConsumer() {}
21
22 public:
23 bool startWriting(const std::string& file, DataClass dataClass);
24
25 bool startWriting(DataClass dataClass) override;
26 void writeGenericSettings(DataClass dataClass, std::string key, std::string settings);
27 bool endWriting(DataClass dataClass) override;
28
29 virtual void setCombineContinuousZones(const bool ifCombZones);
30 virtual void setAppendOn(bool append);
31 virtual void setWriteSettingsOn(bool writeSettings);
32 virtual void setOverrideSettingsOn(bool overrideSettings);
33
34 virtual bool setDatasetNameOfPhase(PhaseIdType, const std::string&);
35 virtual bool setDatasetNameOfVariable(VariableIdType, const std::string&);
36
37 protected:
38 virtual bool openData(DataClass dataClass, const std::string& file);
39 virtual bool closeData(DataClass dataClass);
40
41 protected:
42 void writeCommonSettings(DataClass dataClass);
43};
44
45}
46
47#endif // CFFINTERFACE_CFFINTERFACE_CFFFILECONSUMER_HPP_
Class that provides functions to write data within a CFF database. The database may be stored within ...
Definition: CffConsumer.hpp:18
Class that provides functions to access data stored within a CFF file.
Definition: CffFileConsumer.hpp:18
Base class that provides common function used in File providers such as ansys::CffFileProvider.
Definition: CffFileIO.hpp:17
CffDataClass
An enumeration that is used within the API to caterorize types of CFF data.
Definition: CffTypes.h:415
CffPhaseIdType PhaseIdType
Alias for CffPhaseIdType ('C++' API only)
Definition: Types.hpp:154
CffVariableIdType VariableIdType
Type used to represent the identifier of a variable ('C++' API only)
Definition: Types.hpp:184
Definition: API.dox:1

Connect with Ansys