openPMD-api
ADIOS1IOHandler.hpp
1 /* Copyright 2017-2020 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/IO/AbstractIOHandler.hpp"
25 
26 #include <future>
27 #include <memory>
28 #include <string>
29 #if openPMD_HAVE_ADIOS1
30 # include <queue>
31 #endif
32 
33 #ifdef _MSC_VER
34 # define EXPORT __declspec( dllexport )
35 #elif defined(__NVCC__)
36 # define EXPORT
37 #else
38 # define EXPORT __attribute__((visibility("default")))
39 #endif
40 
41 
42 namespace openPMD
43 {
44  class EXPORT ADIOS1IOHandlerImpl;
45 
46 #if openPMD_HAVE_ADIOS1
47  class EXPORT ADIOS1IOHandler : public AbstractIOHandler
48  {
49  friend class ADIOS1IOHandlerImpl;
50 
51  public:
52  ADIOS1IOHandler(std::string path, AccessType);
53  ~ADIOS1IOHandler() override;
54 
55  std::string backendName() const override { return "ADIOS1"; }
56 
57  std::future< void > flush() override;
58 
59  void enqueue(IOTask const&) override;
60 
61  private:
62  std::queue< IOTask > m_setup;
63  std::unique_ptr< ADIOS1IOHandlerImpl > m_impl;
64  }; // ADIOS1IOHandler
65 #else
66  class EXPORT ADIOS1IOHandler : public AbstractIOHandler
67  {
68  friend class ADIOS1IOHandlerImpl;
69 
70  public:
71  ADIOS1IOHandler(std::string path, AccessType);
72  ~ADIOS1IOHandler() override;
73 
74  std::string backendName() const override { return "DUMMY_ADIOS1"; }
75 
76  std::future< void > flush() override;
77 
78  private:
79  std::unique_ptr< ADIOS1IOHandlerImpl > m_impl;
80  }; // ADIOS1IOHandler
81 #endif
82 } // openPMD
83 
84 #undef EXPORT
AccessType
File access mode to use during IO.
Definition: AccessType.hpp:28
Self-contained description of a single IO operation.
Definition: IOTask.hpp:468
Definition: ADIOS1IOHandler.hpp:47
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:68
Public definitions of openPMD-api.
Definition: Date.cpp:28
Definition: ADIOS1IOHandlerImpl.hpp:51
std::string backendName() const override
The currently used backend.
Definition: ADIOS1IOHandler.hpp:55