HDF5 C++ API Reference Manual

 

 

 

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Examples

H5DxferProp.h

Go to the documentation of this file.
00001 // C++ informative line for the emacs editor: -*- C++ -*- 00002 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 00003 * Copyright by the Board of Trustees of the University of Illinois. * 00004 * All rights reserved. * 00005 * * 00006 * This file is part of HDF5. The full HDF5 copyright notice, including * 00007 * terms governing use, modification, and redistribution, is contained in * 00008 * the files COPYING and Copyright.html. COPYING can be found at the root * 00009 * of the source code distribution tree; Copyright.html can be found at the * 00010 * root level of an installed copy of the electronic HDF5 document set and * 00011 * is linked from the top-level documents page. It can also be found at * 00012 * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * 00013 * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * 00014 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 00015 00016 #ifndef _H5DSetMemXferPropList_H 00017 #define _H5DSetMemXferPropList_H 00018 00019 #ifndef H5_NO_NAMESPACE 00020 namespace H5 { 00021 #endif 00022 00023 class H5_DLLCPP DSetMemXferPropList : public PropList { 00024 public: 00025 // Default dataset memory and transfer property list. 00026 static const DSetMemXferPropList DEFAULT; 00027 00028 #ifdef H5_WANT_H5_V1_4_COMPAT 00029 // Sets type conversion and background buffers. 00030 void setBuffer( hsize_t size, void* tconv, void* bkg ) const; 00031 00032 // Reads buffer settings. 00033 hsize_t getBuffer( void** tconv, void** bkg ) const; 00034 00035 // Indicates whether to cache hyperslab blocks during I/O. 00036 void setHyperCache( bool cache, unsigned limit = 0 ) const; 00037 00038 // Returns information regarding the caching of hyperslab blocks during I/O. 00039 void getHyperCache( bool& cache, unsigned& limit ) const; 00040 00041 #else /* H5_WANT_H5_V1_4_COMPAT */ 00042 // Sets type conversion and background buffers. 00043 void setBuffer( size_t size, void* tconv, void* bkg ) const; 00044 00045 // Reads buffer settings. 00046 size_t getBuffer( void** tconv, void** bkg ) const; 00047 #endif /* H5_WANT_H5_V1_4_COMPAT */ 00048 00049 // Sets B-tree split ratios for a dataset transfer property list. 00050 void setBtreeRatios( double left, double middle, double right ) const; 00051 00052 // Gets B-tree split ratios for a dataset transfer property list. 00053 void getBtreeRatios( double& left, double& middle, double& right ) const; 00054 00055 // Sets the dataset transfer property list status to TRUE or FALSE. 00056 void setPreserve( bool status ) const; 00057 00058 // Checks status of the dataset transfer property list. 00059 bool getPreserve() const; 00060 00061 // Sets the memory manager for variable-length datatype 00062 // allocation in H5Dread and H5Dvlen_reclaim. 00063 void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info, 00064 H5MM_free_t free, void* free_info ) const; 00065 00066 // alloc and free are set to NULL, indicating that system 00067 // malloc and free are to be used. 00068 void setVlenMemManager() const; 00069 00070 // Gets the memory manager for variable-length datatype 00071 // allocation in H5Dread and H5Tvlen_reclaim. 00072 void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info, 00073 H5MM_free_t& free, void** free_info ) const; 00074 00075 // Sets the data transfer property list for the multi-file driver. 00076 void setMulti(const hid_t *memb_dxpl); 00077 00078 // Returns multi-file data transfer property list information. 00079 void getMulti(hid_t *memb_dxpl); 00080 00081 // Sets the size of a contiguous block reserved for small data. 00082 void setSmallDataBlockSize(hsize_t size); 00083 00084 // Returns the current small data block size setting. 00085 hsize_t getSmallDataBlockSize(); 00086 00087 // Sets number of I/O vectors to be read/written in hyperslab I/O. 00088 void setHyperVectorSize(size_t vector_size); 00089 00090 // Returns the number of I/O vectors to be read/written in 00091 // hyperslab I/O. 00092 size_t getHyperVectorSize(); 00093 00094 // Enables or disables error-detecting for a dataset reading 00095 // process. 00096 void setEDCCheck(H5Z_EDC_t check); 00097 00098 // Determines whether error-detection is enabled for dataset reads. 00099 H5Z_EDC_t getEDCCheck(); 00100 00101 // Default constructor: creates a dataset memory and transfer prop list. 00102 DSetMemXferPropList(); 00103 00104 // Copy constructor: makes a copy of a DSetMemXferPropList object. 00105 DSetMemXferPropList(const DSetMemXferPropList& orig); 00106 00107 // Creates a copy of an existing dataset memory and transfer 00108 // property list using the property list id. 00109 DSetMemXferPropList (const hid_t plist_id); 00110 00111 // Noop destructor. 00112 virtual ~DSetMemXferPropList(); 00113 00114 }; 00115 #ifndef H5_NO_NAMESPACE 00116 } 00117 #endif 00118 #endif

Generated on Thu Aug 5 00:22:37 2004 by doxygen 1.3.7-20040718