HDF5 C++ API Reference Manual

 

 

Main Page | Namespace List | Class Hierarchy | Compound List | File List | Compound Members | File 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         static const DSetMemXferPropList DEFAULT;
00026 
00027         // Creates a dataset memory and transfer property list
00028         DSetMemXferPropList();
00029 
00030         // Copy constructor: creates a copy of a DSetMemXferPropList object
00031         DSetMemXferPropList( const DSetMemXferPropList& orig );
00032 
00033         // Sets type conversion and background buffers
00034         void setBuffer( size_t size, void* tconv, void* bkg ) const;
00035 
00036         // Reads buffer settings
00037         size_t getBuffer( void** tconv, void** bkg ) const;
00038 
00039         // Sets the dataset transfer property list status to TRUE or FALSE
00040         void setPreserve( bool status ) const;
00041 
00042         // Checks status of the dataset transfer property list
00043         bool getPreserve() const;
00044 
00045         // Sets B-tree split ratios for a dataset transfer property list
00046         void setBtreeRatios( double left, double middle, double right ) const;
00047 
00048         // Gets B-tree split ratios for a dataset transfer property list
00049         void getBtreeRatios( double& left, double& middle, double& right ) const;
00050 
00051         // Sets an exception handling callback for datatype conversion
00052         void setTypeConvCB( H5T_conv_except_func_t op, void *user_data) const;
00053 
00054         // Gets the exception handling callback for datatype conversion
00055         void getTypeConvCB( H5T_conv_except_func_t *op, void **user_data) const;
00056 
00057         // Sets the memory manager for variable-length datatype
00058         // allocation in H5Dread and H5Dvlen_reclaim
00059         void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info,
00060                                 H5MM_free_t free, void* free_info ) const;
00061 
00062         // alloc and free are set to NULL, indicating that system
00063         // malloc and free are to be used
00064         void setVlenMemManager() const;
00065 
00066         // Gets the memory manager for variable-length datatype
00067         // allocation in H5Dread and H5Tvlen_reclaim
00068         void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info,
00069                                 H5MM_free_t& free, void** free_info ) const;
00070 
00071         // Sets the data transfer property list for the multi-file driver.
00072         void setMulti(const hid_t *memb_dxpl);
00073 
00074         // Returns multi-file data transfer property list information.
00075         void getMulti(hid_t *memb_dxpl);
00076 
00077         // Sets the size of a contiguous block reserved for small data.
00078         void setSmallDataBlockSize(hsize_t size);
00079 
00080         // Returns the current small data block size setting.
00081         hsize_t getSmallDataBlockSize();
00082 
00083         // Sets number of I/O vectors to be read/written in hyperslab I/O.
00084         void setHyperVectorSize(size_t vector_size);
00085 
00086         // Returns the number of I/O vectors to be read/written in
00087         // hyperslab I/O.
00088         size_t getHyperVectorSize();
00089 
00090         // Enables or disables error-detecting for a dataset reading
00091         // process.
00092         void setEDCCheck(H5Z_EDC_t check);
00093 
00094         // Determines whether error-detection is enabled for dataset reads.
00095         H5Z_EDC_t getEDCCheck();
00096 
00097         // Returns this class name
00098         virtual H5std_string fromClass () const { return("DSetMemXferPropList"); }
00099 
00100         // Creates a copy of an existing dataset memory and transfer
00101         // property list using the property list id.
00102         DSetMemXferPropList (const hid_t plist_id);
00103 
00104         // Noop destructor
00105         virtual ~DSetMemXferPropList();
00106 
00107 };
00108 #ifndef H5_NO_NAMESPACE
00109 }
00110 #endif
00111 #endif

Generated on Thu Apr 20 15:16:40 2006 by doxygen 1.3.2