Skip to main content

Common Fluids Format 2023 R2

CffFileProvider

Last update: 16.07.2025
1/*
2 * Copyright ANSYS. All Rights Reserved.
3 */
4
5#ifndef CFFSDK_CFFINTERFACE_CFFFILEPROVIDER_HPP_
6#define CFFSDK_CFFINTERFACE_CFFFILEPROVIDER_HPP_
7
8#include "LibraryType.hpp"
9#include "CffProvider.hpp"
10#include "CffFileIO.hpp"
11
12#include "Types.hpp"
13
14namespace ansys {
15
16class ANSYS_FLUIDS_CFFINTERFACE_DLL CffFileProvider
17 : public CffProvider, public CffFileIO
18{
19 public:
20 virtual ~CffFileProvider();
21
22 public:
23 bool startReading(const std::string& file, DataClass dataClass);
24
25 bool startReading(DataClass dataClass) override;
26 bool endReading(DataClass dataClass) override;
27
28 virtual bool getDatasetNameOfPhase(PhaseIdType, std::string&) const;
29 virtual bool getDatasetNameOfVariable(VariableIdType, std::string&) const;
30
31 protected:
32 virtual bool openData(DataClass dataClass, const std::string& file);
33 virtual bool closeData(DataClass dataClass);
34
35};
36
37}
38
39#endif // CFFSDK_CFFINTERFACE_CFFFILEPROVIDER_HPP_
Base class that provides common function used in File providers such as ansys::CffFileProvider.
Definition: CffFileIO.hpp:17
Class that provides functions to access data stored within a CFF file.
Definition: CffFileProvider.hpp:18
Class that provides functions to access data stored within a CFF database. The database may be stored...
Definition: CffProvider.hpp:21
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