openPMD-api
 
Loading...
Searching...
No Matches
AbstractIOHandlerHelper.hpp
1/* Copyright 2017-2025 Fabian Koller, Axel Huebl, 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#pragma once
22
23#include "openPMD/IO/AbstractIOHandler.hpp"
24#include "openPMD/config.hpp"
25
26namespace openPMD
27{
28#if openPMD_HAVE_MPI
29
51template <typename JSON>
52std::unique_ptr<AbstractIOHandler> createIOHandler(
53 std::optional<std::unique_ptr<AbstractIOHandler>> initialize_from,
54 std::string path,
55 Access access,
56 Format format,
57 std::string originalExtension,
58 MPI_Comm comm,
59 JSON options,
60 std::string const &pathAsItWasSpecifiedInTheConstructor);
61#endif
62
82template <typename JSON>
83std::unique_ptr<AbstractIOHandler> createIOHandler(
84 std::optional<std::unique_ptr<AbstractIOHandler>> initialize_from,
85 std::string path,
86 Access access,
87 Format format,
88 std::string originalExtension,
89 JSON options,
90 std::string const &pathAsItWasSpecifiedInTheConstructor);
91
92// version without configuration to use in AuxiliaryTest
93std::unique_ptr<AbstractIOHandler> createIOHandler(
94 std::optional<std::unique_ptr<AbstractIOHandler>> initialize_from,
95 std::string path,
96 Access access,
97 Format format,
98 std::string originalExtension);
99} // namespace openPMD
Public definitions of openPMD-api.
Definition Date.cpp:29
Access
File access mode to use during IO.
Definition Access.hpp:58
Format
File format to use during IO.
Definition Format.hpp:30