openPMD-api
Dataset.hpp
1 /* Copyright 2017-2021 Fabian Koller, 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 #pragma once
22 
23 #include "openPMD/Datatype.hpp"
24 
25 #include <limits>
26 #include <memory>
27 #include <optional>
28 #include <string>
29 #include <type_traits>
30 #include <vector>
31 
32 namespace openPMD
33 {
34 using Extent = std::vector<std::uint64_t>;
35 using Offset = std::vector<std::uint64_t>;
36 
37 class Dataset
38 {
39  friend class RecordComponent;
40 
41 public:
42  enum : std::uint64_t
43  {
44  JOINED_DIMENSION = std::numeric_limits<std::uint64_t>::max()
45  };
46 
47  Dataset(Datatype, Extent, std::string options = "{}");
48 
55  Dataset(Extent);
56 
57  Dataset &extend(Extent newExtent);
58 
59  Extent extent;
60  Datatype dtype;
61  uint8_t rank;
62  std::string options = "{}";
63 
64  bool empty() const;
65 
66  std::optional<size_t> joinedDimension() const;
67 };
68 } // namespace openPMD
Definition: Dataset.hpp:38
std::string options
backend-dependent JSON configuration
Definition: Dataset.hpp:62
Definition: RecordComponent.hpp:120
Public definitions of openPMD-api.
Definition: Date.cpp:29
Datatype
Concrete datatype of an object available at runtime.
Definition: Datatype.hpp:51