HDF5 C++ API  1.8.20
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5DxferProp.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 __H5DSetMemXferPropList_H
16 #define __H5DSetMemXferPropList_H
17 
18 namespace H5 {
19 
24 // Inheritance: ObjCreatPropList -> PropList -> IdComponent
25 class H5_DLLCPP DSetMemXferPropList : public PropList {
26  public:
29 
30  // Creates a dataset memory and transfer property list.
32 
33  // Creates a dataset transform property list.
34  DSetMemXferPropList(const char* expression);
35 
36  // Sets type conversion and background buffers.
37  void setBuffer(size_t size, void* tconv, void* bkg) const;
38 
39  // Reads buffer settings.
40  size_t getBuffer(void** tconv, void** bkg) const;
41 
42  // Sets B-tree split ratios for a dataset transfer property list.
43  void setBtreeRatios(double left, double middle, double right) const;
44 
45  // Gets B-tree split ratios for a dataset transfer property list.
46  void getBtreeRatios(double& left, double& middle, double& right) const;
47 
48  // Sets data transform expression.
49  void setDataTransform(const char* expression) const;
50  void setDataTransform(const H5std_string& expression) const;
51 
52  // Gets data transform expression.
53  ssize_t getDataTransform(char* exp, size_t buf_size=0) const;
54  H5std_string getDataTransform() const;
55 
56  // Sets the dataset transfer property list status to TRUE or FALSE.
57  void setPreserve(bool status) const;
58 
59  // Checks status of the dataset transfer property list.
60  bool getPreserve() const;
61 
62  // Sets an exception handling callback for datatype conversion.
63  void setTypeConvCB(H5T_conv_except_func_t op, void *user_data) const;
64 
65  // Gets the exception handling callback for datatype conversion.
66  void getTypeConvCB(H5T_conv_except_func_t *op, void **user_data) const;
67 
68  // Sets the memory manager for variable-length datatype
69  // allocation in H5Dread and H5Dvlen_reclaim.
70  void setVlenMemManager(H5MM_allocate_t alloc, void* alloc_info,
71  H5MM_free_t free, void* free_info) const;
72 
73  // alloc and free are set to NULL, indicating that system
74  // malloc and free are to be used.
75  void setVlenMemManager() const;
76 
77  // Gets the memory manager for variable-length datatype
78  // allocation in H5Dread and H5Tvlen_reclaim.
79  void getVlenMemManager(H5MM_allocate_t& alloc, void** alloc_info,
80  H5MM_free_t& free, void** free_info) const;
81 
82  // Sets the size of a contiguous block reserved for small data.
83  void setSmallDataBlockSize(hsize_t size) const;
84 
85  // Returns the current small data block size setting.
86  hsize_t getSmallDataBlockSize() const;
87 
88  // Sets number of I/O vectors to be read/written in hyperslab I/O.
89  void setHyperVectorSize(size_t vector_size) const;
90 
91  // Returns the number of I/O vectors to be read/written in
92  // hyperslab I/O.
93  size_t getHyperVectorSize() const;
94 
95  // Enables or disables error-detecting for a dataset reading
96  // process.
97  void setEDCCheck(H5Z_EDC_t check) const;
98 
99  // Determines whether error-detection is enabled for dataset reads.
100  H5Z_EDC_t getEDCCheck() const;
101 
103  virtual H5std_string fromClass () const { return("DSetMemXferPropList"); }
104 
105  // Copy constructor: makes a copy of a DSetMemXferPropList object.
107 
108  // Creates a copy of an existing dataset memory and transfer
109  // property list using the property list id.
110  DSetMemXferPropList(const hid_t plist_id);
111 
112  // Noop destructor
113  virtual ~DSetMemXferPropList();
114 
115 #ifndef DOXYGEN_SHOULD_SKIP_THIS
116 
117  // Deletes the global constant, should only be used by the library
118  static void deleteConstants();
119 
120  private:
121  static DSetMemXferPropList* DEFAULT_;
122 
123  // Creates the global constant, should only be used by the library
124  static DSetMemXferPropList* getConstant();
125 
126 #endif // DOXYGEN_SHOULD_SKIP_THIS
127 
128 }; // end of DSetMemXferPropList
129 } // namespace H5
130 
131 #endif // __H5DSetMemXferPropList_H
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DxferProp.h:103
Class DSetCreatPropList inherits from PropList and provides wrappers for the HDF5 dataset memory and ...
Definition: H5DxferProp.h:25
static const DSetMemXferPropList & DEFAULT
Default dataset memory and transfer property list.
Definition: H5DxferProp.h:28
Class PropList provides operations for generic property lists.
Definition: H5PropList.h:26


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