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/auxiliary/JSON_internal.hpp"
26 #include "openPMD/config.hpp"
27 
28 #include <future>
29 #include <memory>
30 #include <string>
31 #if openPMD_HAVE_ADIOS1
32 #include <queue>
33 #endif
34 
35 namespace openPMD
36 {
37 class OPENPMDAPI_EXPORT ADIOS1IOHandlerImpl;
38 
39 #if openPMD_HAVE_ADIOS1
40 class OPENPMDAPI_EXPORT ADIOS1IOHandler : public AbstractIOHandler
41 {
42  friend class ADIOS1IOHandlerImpl;
43 
44 public:
45  ADIOS1IOHandler(std::string path, Access, json::TracingJSON);
46  ~ADIOS1IOHandler() override;
47 
48  std::string backendName() const override
49  {
50  return "ADIOS1";
51  }
52 
53  std::future<void> flush(internal::ParsedFlushParams &) override;
54 
55  void enqueue(IOTask const &) override;
56 
57 private:
58  std::queue<IOTask> m_setup;
59  std::unique_ptr<ADIOS1IOHandlerImpl> m_impl;
60 }; // ADIOS1IOHandler
61 #else
62 class OPENPMDAPI_EXPORT ADIOS1IOHandler : public AbstractIOHandler
63 {
64  friend class ADIOS1IOHandlerImpl;
65 
66 public:
67  ADIOS1IOHandler(std::string path, Access, json::TracingJSON);
68  ~ADIOS1IOHandler() override;
69 
70  std::string backendName() const override
71  {
72  return "DUMMY_ADIOS1";
73  }
74 
75  std::future<void> flush(internal::ParsedFlushParams &) override;
76 
77 private:
78  std::unique_ptr<ADIOS1IOHandlerImpl> m_impl;
79 }; // ADIOS1IOHandler
80 #endif
81 } // namespace openPMD
Extend nlohmann::json with tracing of which keys have been accessed by operator[]().
Definition: JSON_internal.hpp:67
Self-contained description of a single IO operation.
Definition: IOTask.hpp:695
Access
File access mode to use during IO.
Definition: Access.hpp:29
Definition: ADIOS1IOHandler.hpp:40
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:179
Public definitions of openPMD-api.
Definition: ADIOS1IOHandlerImpl.hpp:42
std::string backendName() const override
The currently used backend.
Definition: ADIOS1IOHandler.hpp:48
Definition: FlushParametersInternal.hpp:31