openPMD-api
HDF5IOHandlerImpl.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 #if openPMD_HAVE_HDF5
25 # include "openPMD/IO/AbstractIOHandlerImpl.hpp"
26 # include <hdf5.h>
27 # include <unordered_map>
28 # include <unordered_set>
29 #endif
30 
31 
32 namespace openPMD
33 {
34 #if openPMD_HAVE_HDF5
36  {
37  public:
39  ~HDF5IOHandlerImpl() override;
40 
45  void openFile(Writable*, Parameter< Operation::OPEN_FILE > const&) override;
47  void openPath(Writable*, Parameter< Operation::OPEN_PATH > const&) override;
60 
61  std::unordered_map< Writable*, hid_t > m_fileIDs;
62  std::unordered_map< std::string, hid_t > m_fileNamesWithID;
63 
64  std::unordered_set< hid_t > m_openFileIDs;
65 
66  hid_t m_datasetTransferProperty;
67  hid_t m_fileAccessProperty;
68 
69  // h5py compatible types for bool and complex
70  hid_t m_H5T_BOOL_ENUM;
71  hid_t m_H5T_CFLOAT;
72  hid_t m_H5T_CDOUBLE;
73  hid_t m_H5T_CLONG_DOUBLE;
74  }; // HDF5IOHandlerImpl
75 #else
76  class HDF5IOHandlerImpl
77  {
78  }; // HDF5IOHandlerImpl
79 #endif
80 
81 } // openPMD
void writeAttribute(Writable *, Parameter< Operation::WRITE_ATT > const &) override
Create a single attribute and fill the value, possibly overwriting an existing attribute.
Definition: HDF5IOHandler.cpp:862
void readDataset(Writable *, Parameter< Operation::READ_DATASET > &) override
Read a chunk of data from an existing dataset.
Definition: HDF5IOHandler.cpp:1136
void extendDataset(Writable *, Parameter< Operation::EXTEND_DATASET > const &) override
Increase the extent of an existing dataset.
Definition: HDF5IOHandler.cpp:340
void createFile(Writable *, Parameter< Operation::CREATE_FILE > const &) override
Create a new file in physical storage, possibly overriding an existing file.
Definition: HDF5IOHandler.cpp:124
void deleteDataset(Writable *, Parameter< Operation::DELETE_DATASET > const &) override
Delete an existing dataset.
Definition: HDF5IOHandler.cpp:692
void readAttribute(Writable *, Parameter< Operation::READ_ATT > &) override
Read the value of an existing attribute.
Definition: HDF5IOHandler.cpp:1226
void openDataset(Writable *, Parameter< Operation::OPEN_DATASET > &) override
Open an existing dataset and determine its datatype and extent.
Definition: HDF5IOHandler.cpp:513
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:68
void listPaths(Writable *, Parameter< Operation::LIST_PATHS > &) override
List all paths/sub-groups inside a group, non-recursively.
Definition: HDF5IOHandler.cpp:1642
void listDatasets(Writable *, Parameter< Operation::LIST_DATASETS > &) override
List all datasets inside a group, non-recursively.
Definition: HDF5IOHandler.cpp:1677
Public definitions of openPMD-api.
Definition: Date.cpp:28
Layer to mirror structure of logical data and persistent data in file.
Definition: Writable.hpp:55
void openPath(Writable *, Parameter< Operation::OPEN_PATH > const &) override
Open all contained groups in a path, possibly recursively.
Definition: HDF5IOHandler.cpp:476
void deleteAttribute(Writable *, Parameter< Operation::DELETE_ATT > const &) override
Delete an existing attribute.
Definition: HDF5IOHandler.cpp:736
void createPath(Writable *, Parameter< Operation::CREATE_PATH > const &) override
Create all necessary groups for a path, possibly recursively.
Definition: HDF5IOHandler.cpp:162
void closeFile(Writable *, Parameter< Operation::CLOSE_FILE > const &) override
Close the file corresponding with the writable and release file handles.
Definition: HDF5IOHandler.cpp:437
void createDataset(Writable *, Parameter< Operation::CREATE_DATASET > const &) override
Create a new dataset of given type, extent and storage properties.
Definition: HDF5IOHandler.cpp:225
void deletePath(Writable *, Parameter< Operation::DELETE_PATH > const &) override
Delete all objects within an existing path.
Definition: HDF5IOHandler.cpp:648
void deleteFile(Writable *, Parameter< Operation::DELETE_FILE > const &) override
Delete an existing file from physical storage.
Definition: HDF5IOHandler.cpp:617
void writeDataset(Writable *, Parameter< Operation::WRITE_DATASET > const &) override
Write a chunk of data into an existing dataset.
Definition: HDF5IOHandler.cpp:765
Definition: HDF5IOHandlerImpl.hpp:35
Definition: AbstractIOHandlerImpl.hpp:35
void openFile(Writable *, Parameter< Operation::OPEN_FILE > const &) override
Open an existing file assuming it conforms to openPMD.
Definition: HDF5IOHandler.cpp:383
void listAttributes(Writable *, Parameter< Operation::LIST_ATTS > &) override
List all attributes associated with an object.
Definition: HDF5IOHandler.cpp:1711