HDF5 C++ API  1.8.13
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 files COPYING and Copyright.html. COPYING can be found at the root *
10  * of the source code distribution tree; Copyright.html can be found at the *
11  * root level of an installed copy of the electronic HDF5 document set and *
12  * is linked from the top-level documents page. It can also be found at *
13  * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
14  * access to either file, you may request a copy from help@hdfgroup.org. *
15  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
16 
17 // Class DSetMemXferPropList represents the HDF5 dataset transfer property list
18 // and inherits from PropList.
19 
20 #ifndef __H5DSetMemXferPropList_H
21 #define __H5DSetMemXferPropList_H
22 
23 #ifndef H5_NO_NAMESPACE
24 namespace H5 {
25 #endif
26 
31 class H5_DLLCPP DSetMemXferPropList : public PropList {
32  public:
34 
35  // Creates a dataset memory and transfer property list.
37 
38  // Creates a dataset transform property list.
39  DSetMemXferPropList(const char* expression);
40 
41  // Sets type conversion and background buffers.
42  void setBuffer( size_t size, void* tconv, void* bkg ) const;
43 
44  // Reads buffer settings.
45  size_t getBuffer( void** tconv, void** bkg ) const;
46 
47  // Sets B-tree split ratios for a dataset transfer property list.
48  void setBtreeRatios( double left, double middle, double right ) const;
49 
50  // Gets B-tree split ratios for a dataset transfer property list.
51  void getBtreeRatios( double& left, double& middle, double& right ) const;
52 
53  // Sets data transform expression.
54  void setDataTransform(const char* expression) const;
55  void setDataTransform(const H5std_string& expression) const;
56 
57  // Gets data transform expression.
58  ssize_t getDataTransform(char* exp, size_t buf_size=0) const;
59  H5std_string getDataTransform() const;
60 
61  // Sets the dataset transfer property list status to TRUE or FALSE.
62  void setPreserve( bool status ) const;
63 
64  // Checks status of the dataset transfer property list.
65  bool getPreserve() const;
66 
67  // Sets an exception handling callback for datatype conversion.
68  void setTypeConvCB( H5T_conv_except_func_t op, void *user_data) const;
69 
70  // Gets the exception handling callback for datatype conversion.
71  void getTypeConvCB( H5T_conv_except_func_t *op, void **user_data) const;
72 
73  // Sets the memory manager for variable-length datatype
74  // allocation in H5Dread and H5Dvlen_reclaim.
75  void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info,
76  H5MM_free_t free, void* free_info ) const;
77 
78  // alloc and free are set to NULL, indicating that system
79  // malloc and free are to be used.
80  void setVlenMemManager() const;
81 
82  // Gets the memory manager for variable-length datatype
83  // allocation in H5Dread and H5Tvlen_reclaim.
84  void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info,
85  H5MM_free_t& free, void** free_info ) const;
86 
87  // Sets the size of a contiguous block reserved for small data.
88  void setSmallDataBlockSize(hsize_t size);
89 
90  // Returns the current small data block size setting.
91  hsize_t getSmallDataBlockSize();
92 
93  // Sets number of I/O vectors to be read/written in hyperslab I/O.
94  void setHyperVectorSize(size_t vector_size);
95 
96  // Returns the number of I/O vectors to be read/written in
97  // hyperslab I/O.
98  size_t getHyperVectorSize();
99 
100  // Enables or disables error-detecting for a dataset reading
101  // process.
102  void setEDCCheck(H5Z_EDC_t check);
103 
104  // Determines whether error-detection is enabled for dataset reads.
105  H5Z_EDC_t getEDCCheck();
106 
108  virtual H5std_string fromClass () const { return("DSetMemXferPropList"); }
109 
110  // Copy constructor: makes a copy of a DSetMemXferPropList object.
112 
113  // Creates a copy of an existing dataset memory and transfer
114  // property list using the property list id.
115  DSetMemXferPropList(const hid_t plist_id);
116 
117  // Noop destructor
118  virtual ~DSetMemXferPropList();
119 };
120 #ifndef H5_NO_NAMESPACE
121 }
122 #endif
123 #endif // __H5DSetMemXferPropList_H
Definition: H5AbstractDs.cpp:29
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DxferProp.h:108
Class DSetMemXferPropList represents the dataset memory and transfer property list.
Definition: H5DxferProp.h:31
Class PropList provides operations for generic property lists.
Definition: H5PropList.h:25
static const DSetMemXferPropList DEFAULT
Constant for default dataset memory and transfer property list.
Definition: H5DxferProp.h:33