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/config.hpp"
24 #include "openPMD/auxiliary/Export.hpp"
25 #include "openPMD/IO/AbstractIOHandler.hpp"
26 
27 #include <future>
28 #include <memory>
29 #include <string>
30 #if openPMD_HAVE_ADIOS1
31 # include <queue>
32 #endif
33 
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);
46  ~ADIOS1IOHandler() override;
47 
48  std::string backendName() const override { return "ADIOS1"; }
49 
50  std::future< void > flush() override;
51 
52  void enqueue(IOTask const&) override;
53 
54  private:
55  std::queue< IOTask > m_setup;
56  std::unique_ptr< ADIOS1IOHandlerImpl > m_impl;
57  }; // ADIOS1IOHandler
58 #else
59  class OPENPMDAPI_EXPORT ADIOS1IOHandler : public AbstractIOHandler
60  {
61  friend class ADIOS1IOHandlerImpl;
62 
63  public:
64  ADIOS1IOHandler(std::string path, Access);
65  ~ADIOS1IOHandler() override;
66 
67  std::string backendName() const override { return "DUMMY_ADIOS1"; }
68 
69  std::future< void > flush() override;
70 
71  private:
72  std::unique_ptr< ADIOS1IOHandlerImpl > m_impl;
73  }; // ADIOS1IOHandler
74 #endif
75 } // openPMD
openPMD::ADIOS1IOHandler
Definition: ADIOS1IOHandler.hpp:40
openPMD::AbstractIOHandler
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:98
openPMD
Public definitions of openPMD-api.
Definition: Date.cpp:29
openPMD::IOTask
Self-contained description of a single IO operation.
Definition: IOTask.hpp:589
openPMD::ADIOS1IOHandler::backendName
std::string backendName() const override
The currently used backend.
Definition: ADIOS1IOHandler.hpp:48
openPMD::Access
Access
File access mode to use during IO.
Definition: Access.hpp:28
openPMD::ADIOS1IOHandlerImpl
Definition: ADIOS1IOHandlerImpl.hpp:44