openPMD-api
JSONIOHandler.hpp
1 /* Copyright 2017-2021 Franz Poeschel
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 
22 #pragma once
23 
24 #include "openPMD/IO/AbstractIOHandler.hpp"
25 #include "openPMD/IO/JSON/JSONIOHandlerImpl.hpp"
26 
27 #if openPMD_HAVE_MPI
28 #include <mpi.h>
29 #endif
30 
31 namespace openPMD
32 {
34 {
35 public:
37  std::string path,
38  Access at,
40  JSONIOHandlerImpl::FileFormat,
41  std::string originalExtension);
42 #if openPMD_HAVE_MPI
44  std::string path,
45  Access at,
46  MPI_Comm,
48  JSONIOHandlerImpl::FileFormat,
49  std::string originalExtension);
50 #endif
51 
52  ~JSONIOHandler() override;
53 
54  std::string backendName() const override
55  {
56  return "JSON";
57  }
58 
59  std::future<void> flush(internal::ParsedFlushParams &) override;
60 
61 private:
62  JSONIOHandlerImpl m_impl;
63 };
64 } // namespace openPMD
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:186
Definition: JSONIOHandler.hpp:34
std::future< void > flush(internal::ParsedFlushParams &) override
Process operations in queue according to FIFO.
Definition: JSONIOHandler.cpp:52
std::string backendName() const override
The currently used backend.
Definition: JSONIOHandler.hpp:54
Definition: JSONIOHandlerImpl.hpp:158
Extend nlohmann::json with tracing of which keys have been accessed by operator[]().
Definition: JSON_internal.hpp:68
Public definitions of openPMD-api.
Definition: Date.cpp:29
Access
File access mode to use during IO.
Definition: Access.hpp:30
Definition: FlushParametersInternal.hpp:32