h5cpp  0.6.0
A modern C++ wrapper for the HDF5 C library
file_creation.hpp
Go to the documentation of this file.
1 //
2 // (c) Copyright 2017 DESY,ESS
3 //
4 // This file is part of h5cpp.
5 //
6 // This library is free software; you can redistribute it and/or modify it
7 // under the terms of the GNU Lesser General Public License as published
8 // by the Free Software Foundation; either version 2.1 of the License, or
9 // (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
13 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 // License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public License
17 // along with this library; if not, write to the
18 // Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
19 // Boston, MA 02110-1301 USA
20 // ===========================================================================
21 //
22 // Authors:
23 // Eugen Wintersberger <eugen.wintersberger@desy.de>
24 // Martin Shetty <martin.shetty@esss.se>
25 // Created on: Aug 18, 2017
26 //
27 #pragma once
28 
30 #include <h5cpp/core/windows.hpp>
31 
32 namespace hdf5 {
33 namespace property {
34 
39  public:
44  ~FileCreationList() override;
45 
56  explicit FileCreationList(ObjectHandle &&handle);
57 
61  void user_block(hsize_t size) const;
65  hsize_t user_block() const;
66 
70  void object_offset_size(size_t size) const;
74  size_t object_offset_size() const;
75 
79  void object_length_size(size_t size) const;
83  size_t object_length_size() const;
84 
88  void btree_rank(unsigned int ik);
92  unsigned int btree_rank() const;
93 
97  void btree_symbols(unsigned int lk);
101  unsigned int btree_symbols() const;
105  void chunk_tree_rank(unsigned int ik);
109  unsigned int chunk_tree_rank() const;
110 
111 #if (defined(_DOXYGEN_) || H5_VERSION_GE(1,10,1))
115  void page_size(hsize_t size);
119  hsize_t page_size() const;
120 #endif
121 
122 // The following still need wrapping
123 // H5Pset_file_space_strategy
124 // H5Pget_file_space_strategy
125 //
126 // H5Pset_shared_mesg_nindexes
127 // H5Pget_shared_mesg_nindexes
128 //
129 // H5Pset_shared_mesg_index
130 // H5Pget_shared_mesg_index
131 //
132 // H5Pset_shared_mesg_phase_change
133 // H5Pget_shared_mesg_phase_change
134 
135 // DO NOT WRAP the following:
136 // H5Pget_version -- deprecated in favor of H5Fget_info
137 
138 };
139 
140 } // namespace property
141 } // namespace hdf5
Wrapper for hid_t object identifiers.
Definition: object_handle.hpp:67
dataset creation property list
Definition: file_creation.hpp:38
unsigned int btree_rank() const
get btree rank
void object_offset_size(size_t size) const
set object offset size
void btree_rank(unsigned int ik)
set btree rank
size_t object_offset_size() const
get object offset size
FileCreationList(ObjectHandle &&handle)
constructor
void page_size(hsize_t size)
set page size (since hdf5 1.10.1)
FileCreationList()
default constructor
void object_length_size(size_t size) const
set object length size
unsigned int btree_symbols() const
get btree symbols
void chunk_tree_rank(unsigned int ik)
set chunk tree rank
hsize_t user_block() const
get user block
size_t object_length_size() const
get object length size
hsize_t page_size() const
get page size (since hdf5 1.10.1)
void user_block(hsize_t size) const
set user block
void btree_symbols(unsigned int lk)
set btree symbols
unsigned int chunk_tree_rank() const
get chunk tree rank
Definition: group_creation.hpp:36
top-level namespace of the entire library
Definition: attribute.hpp:45
#define DLL_EXPORT
Definition: windows.hpp:29