MISR Toolkit  1.5.1
H5FcreatProp.h
Go to the documentation of this file.
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
26  public:
28  static const FileCreatPropList& DEFAULT;
29 
30  // Creates a file create property list.
32 
33  // Retrieves version information for various parts of a file.
34  void getVersion(unsigned& super, unsigned& freelist, unsigned& stab, unsigned& shhdr) const;
35 
36  // Sets the userblock size field of a file creation property list.
37  void setUserblock(hsize_t size) const;
38 
39  // Gets the size of a user block in this file creation property list.
40  hsize_t getUserblock() const;
41 
42  // Retrieves the size-of address and size quantities stored in a
43  // file according to this file creation property list.
44  void getSizes(size_t& sizeof_addr, size_t& sizeof_size) const;
45 
46  // Sets file size-of addresses and sizes.
47  void setSizes(size_t sizeof_addr = 4, size_t sizeof_size = 4) const;
48 
49  // Retrieves the size of the symbol table B-tree 1/2 rank and the
50  // symbol table leaf node 1/2 size.
51  void getSymk(unsigned& int_nodes_k, unsigned& leaf_nodes_k) const;
52 
53  // Sets the size of parameters used to control the symbol table nodes.
54  void setSymk(unsigned int_nodes_k, unsigned leaf_nodes_k) const;
55 
56  // Returns the 1/2 rank of an indexed storage B-tree.
57  unsigned getIstorek() const;
58 
59  // Sets the size of parameter used to control the B-trees for
60  // indexing chunked datasets.
61  void setIstorek(unsigned ik) const;
62 
64  virtual H5std_string fromClass () const { return("FileCreatPropList"); }
65 
66  // Copy constructor: creates a copy of a FileCreatPropList object.
68 
69  // Creates a copy of an existing file create property list
70  // using the property list id.
71  FileCreatPropList (const hid_t plist_id);
72 
73  // Noop destructor
74  virtual ~FileCreatPropList();
75 
76 #ifndef DOXYGEN_SHOULD_SKIP_THIS
77 
78  // Deletes the global constant, should only be used by the library
79  static void deleteConstants();
80 
81  private:
83 
84  // Creates the global constant, should only be used by the library
85  static FileCreatPropList* getConstant();
86 
87 #endif // DOXYGEN_SHOULD_SKIP_THIS
88 
89 }; // end of FileCreatPropList
90 } // namespace H5
91 
92 #endif // __H5FileCreatPropList_H
#define H5_DLLCPP
Definition: H5api_adpt.h:262
unsigned long long hsize_t
Definition: H5public.h:169
static const FileCreatPropList & DEFAULT
Default file creation property list.
Definition: H5FcreatProp.h:28
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5FcreatProp.h:64
Class FileCreatPropList inherits from PropList and provides wrappers for the HDF5 file create propert...
Definition: H5FcreatProp.h:25
static FileCreatPropList * DEFAULT_
Definition: H5FcreatProp.h:82
#define H5std_string
Definition: H5Exception.h:25
HDFFCLIBAPI intf * size
int hid_t
Definition: H5Ipublic.h:54
Class PropList provides operations for generic property lists.
Definition: H5PropList.h:26

MISR Toolkit - Copyright © 2005 - 2020 Jet Propulsion Laboratory
Generated on Fri Jun 19 2020 22:49:52