openPMD-api
WriteIterations.hpp
1 /* Copyright 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 #pragma once
22 
23 #include "openPMD/Iteration.hpp"
24 #include "openPMD/backend/Container.hpp"
25 
26 #include <optional>
27 
28 namespace openPMD
29 {
30 class Series;
31 
48 namespace internal
49 {
50  class SeriesData;
51 }
52 
67 {
68  friend class Series;
69  friend class internal::SeriesData;
70 
71 private:
72  using IterationsContainer_t =
74 
75 public:
76  using key_type = IterationsContainer_t::key_type;
77  using mapped_type = IterationsContainer_t::mapped_type;
78  using value_type = IterationsContainer_t::value_type;
79  using reference = IterationsContainer_t::reference;
80 
81 private:
82  struct SharedResources
83  {
84  IterationsContainer_t iterations;
86  std::optional<Iteration::IterationIndex_t> currentlyOpen;
87 
88  SharedResources(IterationsContainer_t);
89  ~SharedResources();
90  };
91 
93  explicit WriteIterations() = default;
94  // std::optional so that a single instance is able to close this without
95  // needing to wait for all instances to deallocate
96  std::shared_ptr<std::optional<SharedResources>> shared;
97 
98  void close();
99 
100 public:
101  mapped_type &operator[](key_type const &key);
102  mapped_type &operator[](key_type &&key);
103 
107  std::optional<IndexedIteration> currentIteration();
108 };
109 } // namespace openPMD
Implementation for the root level of the openPMD hierarchy.
Definition: Series.hpp:219
Writing side of the streaming API.
Definition: WriteIterations.hpp:67
std::optional< IndexedIteration > currentIteration()
Return the iteration that is currently being written to, if it exists.
Definition: WriteIterations.cpp:105
Data members for Series.
Definition: Series.hpp:79
Public definitions of openPMD-api.
Definition: Date.cpp:29