AccessType.hpp
Go to the documentation of this file.
1 // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 /// \file
5 /// Defines enum for specifying whether the H5 file is ReadWrite or ReadOnly
6 
7 #pragma once
8 
9 #include <iosfwd>
10 
11 /*!
12  * \ingroup HDF5Group
13  * \brief Contains functions and classes for manipulating HDF5 files
14  *
15  * Wraps many underlying C H5 routines making them easier to use and easier to
16  * manipulate H5 files.
17  */
18 namespace h5 {
19 /*!
20  * \ingroup HDF5Group
21  * \brief Set the access type to the H5File
22  */
23 enum class AccessType {
24  /// Allow read-write access to the file
25  ReadWrite,
26  /// Allow only read access to the file
27  ReadOnly
28 };
29 
30 std::ostream& operator<<(std::ostream& os, AccessType t) noexcept;
31 } // namespace h5
Contains functions and classes for manipulating HDF5 files.
Definition: AccessType.cpp:10
Allow only read access to the file.
AccessType
Set the access type to the H5File.
Definition: AccessType.hpp:23
Allow read-write access to the file.