HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5FcreatProp.h
1 // C++ informative line for the emacs editor: -*- C++ -*-
2 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3  * Copyright by The HDF Group. *
4  * Copyright by the Board of Trustees of the University of Illinois. *
5  * All rights reserved. *
6  * *
7  * This file is part of HDF5. The full HDF5 copyright notice, including *
8  * terms governing use, modification, and redistribution, is contained in *
9  * the COPYING file, which can be found at the root of the source code *
10  * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef __H5FileCreatPropList_H
16 #define __H5FileCreatPropList_H
17 
18 namespace H5 {
19 
24 // Inheritance: PropList -> IdComponent
25 class H5_DLLCPP FileCreatPropList : public PropList {
26  public:
28  static const FileCreatPropList& DEFAULT;
29 
30  // Creates a file create property list.
32 
33 #ifndef H5_NO_DEPRECATED_SYMBOLS
34  // Retrieves version information for various parts of a file.
35  void getVersion(unsigned& super, unsigned& freelist, unsigned& stab, unsigned& shhdr) const;
36 #endif /* H5_NO_DEPRECATED_SYMBOLS */
37 
38  // Sets the userblock size field of a file creation property list.
39  void setUserblock(hsize_t size) const;
40 
41  // Gets the size of a user block in this file creation property list.
42  hsize_t getUserblock() const;
43 
44  // Retrieves the size-of address and size quantities stored in a
45  // file according to this file creation property list.
46  void getSizes(size_t& sizeof_addr, size_t& sizeof_size) const;
47 
48  // Sets file size-of addresses and sizes.
49  void setSizes(size_t sizeof_addr = 4, size_t sizeof_size = 4) const;
50 
51  // Retrieves the size of the symbol table B-tree 1/2 rank and the
52  // symbol table leaf node 1/2 size.
53  void getSymk(unsigned& int_nodes_k, unsigned& leaf_nodes_k) const;
54 
55  // Sets the size of parameters used to control the symbol table nodes.
56  void setSymk(unsigned int_nodes_k, unsigned leaf_nodes_k) const;
57 
58  // Returns the 1/2 rank of an indexed storage B-tree.
59  unsigned getIstorek() const;
60 
61  // Sets the size of parameter used to control the B-trees for
62  // indexing chunked datasets.
63  void setIstorek(unsigned ik) const;
64 
65  // Sets the strategy and the threshold value that the library will
66  // will employ in managing file space.
67  void setFileSpaceStrategy(H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold) const;
68 
69  // Returns the strategy that the library uses in managing file space.
70  void getFileSpaceStrategy(H5F_fspace_strategy_t& strategy, hbool_t& persist, hsize_t& threshold) const;
71 
72  // Sets the file space page size for paged aggregation.
73  void setFileSpacePagesize(hsize_t fsp_psize) const;
74 
75  // Returns the threshold value that the library uses in tracking free
76  // space sections.
77  hsize_t getFileSpacePagesize() const;
78 
80  virtual H5std_string fromClass() const { return("FileCreatPropList"); }
81 
82  // Copy constructor: creates a copy of a FileCreatPropList object.
84 
85  // Creates a copy of an existing file create property list
86  // using the property list id.
87  FileCreatPropList(const hid_t plist_id);
88 
89  // Noop destructor
90  virtual ~FileCreatPropList();
91 
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 
94  // Deletes the global constant, should only be used by the library
95  static void deleteConstants();
96 
97  private:
98  static FileCreatPropList* DEFAULT_;
99 
100  // Creates the global constant, should only be used by the library
101  static FileCreatPropList* getConstant();
102 
103 #endif // DOXYGEN_SHOULD_SKIP_THIS
104 
105 }; // end of FileCreatPropList
106 } // namespace H5
107 
108 #endif // __H5FileCreatPropList_H
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5FcreatProp.h:80
static const FileCreatPropList & DEFAULT
Default file creation property list.
Definition: H5FcreatProp.h:28
Class FileCreatPropList inherits from PropList and provides wrappers for the HDF5 file create propert...
Definition: H5FcreatProp.h:25
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list...
Definition: H5PropList.h:24


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois