openPMD-api
ChunkInfo.hpp
1 /* Copyright 2020-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/Dataset.hpp" // Offset, Extent
24 
25 #include <vector>
26 
27 namespace openPMD
28 {
34 struct ChunkInfo
35 {
36  Offset offset;
37  Extent extent;
38 
39  /*
40  * If rank is smaller than zero, will be converted to zero.
41  */
42  explicit ChunkInfo() = default;
43  ChunkInfo(Offset, Extent);
44 
45  bool operator==(ChunkInfo const &other) const;
46 };
47 
62 {
63  unsigned int sourceID = 0;
64 
65  explicit WrittenChunkInfo() = default;
66  /*
67  * If rank is smaller than zero, will be converted to zero.
68  */
69  WrittenChunkInfo(Offset, Extent, int sourceID);
70  WrittenChunkInfo(Offset, Extent);
71 
72  bool operator==(WrittenChunkInfo const &other) const;
73 };
74 
75 using ChunkTable = std::vector<WrittenChunkInfo>;
76 } // namespace openPMD
Represents the meta info around a chunk that has been written by some data producing application...
Definition: ChunkInfo.hpp:61
Extent extent
size of the chunk
Definition: ChunkInfo.hpp:37
Represents the meta info around a chunk in a dataset.
Definition: ChunkInfo.hpp:34
Public definitions of openPMD-api.
Definition: Date.cpp:28
Offset offset
origin of the chunk
Definition: ChunkInfo.hpp:36