openPMD-api
ADIOS1IOHandler.hpp
1 /* Copyright 2017-2021 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "openPMD/IO/AbstractIOHandler.hpp"
24 #include "openPMD/auxiliary/Export.hpp"
25 #include "openPMD/config.hpp"
26 
27 #include <future>
28 #include <memory>
29 #include <string>
30 #if openPMD_HAVE_ADIOS1
31 #include <queue>
32 #endif
33 
34 namespace openPMD
35 {
36 class OPENPMDAPI_EXPORT ADIOS1IOHandlerImpl;
37 
38 #if openPMD_HAVE_ADIOS1
39 class OPENPMDAPI_EXPORT ADIOS1IOHandler : public AbstractIOHandler
40 {
41  friend class ADIOS1IOHandlerImpl;
42 
43 public:
44  ADIOS1IOHandler(std::string path, Access);
45  ~ADIOS1IOHandler() override;
46 
47  std::string backendName() const override
48  {
49  return "ADIOS1";
50  }
51 
52  std::future<void> flush(internal::FlushParams const &) override;
53 
54  void enqueue(IOTask const &) override;
55 
56 private:
57  std::queue<IOTask> m_setup;
58  std::unique_ptr<ADIOS1IOHandlerImpl> m_impl;
59 }; // ADIOS1IOHandler
60 #else
61 class OPENPMDAPI_EXPORT ADIOS1IOHandler : public AbstractIOHandler
62 {
63  friend class ADIOS1IOHandlerImpl;
64 
65 public:
66  ADIOS1IOHandler(std::string path, Access);
67  ~ADIOS1IOHandler() override;
68 
69  std::string backendName() const override
70  {
71  return "DUMMY_ADIOS1";
72  }
73 
74  std::future<void> flush(internal::FlushParams const &) override;
75 
76 private:
77  std::unique_ptr<ADIOS1IOHandlerImpl> m_impl;
78 }; // ADIOS1IOHandler
79 #endif
80 } // namespace openPMD
Self-contained description of a single IO operation.
Definition: IOTask.hpp:615
Access
File access mode to use during IO.
Definition: Access.hpp:27
Definition: ADIOS1IOHandler.hpp:39
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:122
Public definitions of openPMD-api.
Definition: Date.cpp:28
Definition: ADIOS1IOHandlerImpl.hpp:43
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:103
std::string backendName() const override
The currently used backend.
Definition: ADIOS1IOHandler.hpp:47