All Classes Namespaces Functions Variables Typedefs Friends Pages
H5DaccProp.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 __H5DSetAccPropList_H
16 #define __H5DSetAccPropList_H
17 
18 namespace H5 {
19 
24 // Inheritance: LinkAccPropList -> PropList -> IdComponent
25 class H5_DLLCPP DSetAccPropList : public LinkAccPropList {
26  public:
28  static const DSetAccPropList& DEFAULT;
29 
30  // Creates a dataset creation property list.
32 
33  // Sets the raw data chunk cache parameters.
34  void setChunkCache(size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0) const;
35 
36  // Retrieves the raw data chunk cache parameters.
37  void getChunkCache(size_t &rdcc_nslots, size_t &rdcc_nbytes, double &rdcc_w0) const;
38 
40  virtual H5std_string fromClass () const { return("DSetAccPropList"); }
41 
42  // Copy constructor - same as the original DSetAccPropList.
43  DSetAccPropList(const DSetAccPropList& orig);
44 
45  // Creates a copy of an existing dataset creation property list
46  // using the property list id.
47  DSetAccPropList(const hid_t plist_id);
48 
49  // Noop destructor.
50  virtual ~DSetAccPropList();
51 
52 #ifndef DOXYGEN_SHOULD_SKIP_THIS
53 
54  // Deletes the global constant, should only be used by the library
55  static void deleteConstants();
56 
57  private:
58  static DSetAccPropList* DEFAULT_;
59 
60  // Creates the global constant, should only be used by the library
61  static DSetAccPropList* getConstant();
62 
63 #endif // DOXYGEN_SHOULD_SKIP_THIS
64 
65 }; // end of DSetAccPropList
66 } // namespace H5
67 
68 #endif // __H5DSetAccPropList_H
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DaccProp.h:40
static const DSetAccPropList & DEFAULT
Default dataset creation property list.
Definition: H5DaccProp.h:28
Class DSetAccPropList inherits from LinkAccPropList and provides wrappers for the HDF5 dataset access...
Definition: H5DaccProp.h:25


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