My Project  1.10.8
H5OcreatProp.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://www.hdfgroup.org/licenses. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef H5ObjCreatPropList_H
16 #define H5ObjCreatPropList_H
17 
18 namespace H5 {
19 
24 // Inheritance: PropList -> IdComponent
25 class H5_DLLCPP ObjCreatPropList : public PropList {
26  public:
28  static const ObjCreatPropList &DEFAULT;
29 
30  // Creates a object creation property list.
32 
33  // Sets attribute storage phase change thresholds.
34  void setAttrPhaseChange(unsigned max_compact = 8, unsigned min_dense = 6) const;
35 
36  // Gets attribute storage phase change thresholds.
37  void getAttrPhaseChange(unsigned &max_compact, unsigned &min_dense) const;
38 
39  // Sets tracking and indexing of attribute creation order.
40  void setAttrCrtOrder(unsigned crt_order_flags) const;
41 
42  // Gets tracking and indexing settings for attribute creation order.
43  unsigned getAttrCrtOrder() const;
44 
46  virtual H5std_string
47  fromClass() const
48  {
49  return ("ObjCreatPropList");
50  }
51 
52  // Copy constructor: same as the original ObjCreatPropList.
53  ObjCreatPropList(const ObjCreatPropList &original);
54 
55  // Creates a copy of an existing object creation property list
56  // using the property list id.
57  ObjCreatPropList(const hid_t plist_id);
58 
59  // Noop destructor
60  virtual ~ObjCreatPropList();
61 
62 #ifndef DOXYGEN_SHOULD_SKIP_THIS
63 
64  // Deletes the global constant, should only be used by the library
65  static void deleteConstants();
66 
67  private:
68  static ObjCreatPropList *DEFAULT_;
69 
70  // Creates the global constant, should only be used by the library
71  static ObjCreatPropList *getConstant();
72 
73 #endif // DOXYGEN_SHOULD_SKIP_THIS
74 
75 }; // end of ObjCreatPropList
76 } // namespace H5
77 
78 #endif // H5ObjCreatPropList_H
Class ObjCreatPropList inherits from PropList and provides wrappers for the HDF5 object create proper...
Definition: H5OcreatProp.h:25
static const ObjCreatPropList & DEFAULT
Default object creation property list.
Definition: H5OcreatProp.h:28
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5OcreatProp.h:47
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition: H5PropList.h:25
Definition: H5AbstractDs.cpp:34


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