openPMD-api
 
Loading...
Searching...
No Matches
JSONIOHandler.hpp
1/* Copyright 2017-2025 Franz Poeschel, Axel Huebl
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#include "openPMD/auxiliary/JSON_internal.hpp"
27
28#if openPMD_HAVE_MPI
29#include <mpi.h>
30#endif
31
32namespace openPMD
33{
34class JSONIOHandler : public AbstractIOHandler
35{
36public:
37 JSONIOHandler(
38 std::optional<std::unique_ptr<AbstractIOHandler>> initialize_from,
39 std::string path,
40 Access at,
42 JSONIOHandlerImpl::FileFormat,
43 std::string originalExtension);
44#if openPMD_HAVE_MPI
45 JSONIOHandler(
46 std::optional<std::unique_ptr<AbstractIOHandler>> initialize_from,
47 std::string path,
48 Access at,
49 MPI_Comm,
51 JSONIOHandlerImpl::FileFormat,
52 std::string originalExtension);
53#endif
54
55 ~JSONIOHandler() override;
56
57 std::string backendName() const override
58 {
59 return "JSON";
60 }
61
62 std::future<void> flush(internal::ParsedFlushParams &) override;
63
64private:
65 JSONIOHandlerImpl m_impl;
66};
67} // namespace openPMD
std::future< void > flush(internal::ParsedFlushParams &) override
Process operations in queue according to FIFO.
Definition JSONIOHandler.cpp:54
std::string backendName() const override
The currently used backend.
Definition JSONIOHandler.hpp:57
Definition JSONIOHandlerImpl.hpp:159
Extend nlohmann::json with tracing of which keys have been accessed by operator[]().
Definition JSON_internal.hpp:69
Public definitions of openPMD-api.
Definition Date.cpp:29
Access
File access mode to use during IO.
Definition Access.hpp:58
Definition FlushParametersInternal.hpp:32