HDF5 C++ API Reference Manual

 

 

 

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

H5FcreatProp.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 _H5FileCreatPropList_H 00017 #define _H5FileCreatPropList_H 00018 00019 #ifndef H5_NO_NAMESPACE 00020 namespace H5 { 00021 #endif 00022 00023 // class for file access properties 00024 class H5_DLLCPP FileCreatPropList : public PropList { 00025 public: 00026 static const FileCreatPropList DEFAULT; 00027 00028 // Retrieves version information for various parts of a file. 00029 void getVersion( unsigned& super, unsigned& freelist, unsigned& stab, unsigned& shhdr ) const; 00030 00031 // Sets the userblock size field of a file creation property list. 00032 void setUserblock( hsize_t size ) const; 00033 00034 // Gets the size of a user block in this file creation property list. 00035 hsize_t getUserblock() const; 00036 00037 // Sets file size-of addresses and sizes. 00038 void setSizes( size_t sizeof_addr = 4, size_t sizeof_size = 4 ) const; 00039 00040 // Retrieves the size-of address and size quantities stored in a 00041 // file according to this file creation property list. 00042 void getSizes( size_t& sizeof_addr, size_t& sizeof_size ) const; 00043 00044 // Sets the size of parameters used to control the symbol table nodes. 00045 void setSymk( unsigned int_nodes_k, unsigned leaf_nodes_k ) const; 00046 00047 // Retrieves the size of the symbol table B-tree 1/2 rank and the 00048 // symbol table leaf node 1/2 size. 00049 void getSymk( unsigned& int_nodes_k, unsigned& leaf_nodes_k ) const; 00050 00051 // Sets the size of parameter used to control the B-trees for 00052 // indexing chunked datasets. 00053 void setIstorek( unsigned ik ) const; 00054 00055 // Returns the 1/2 rank of an indexed storage B-tree. 00056 unsigned getIstorek() const; 00057 00058 // Creates a file create property list. 00059 FileCreatPropList(); 00060 00061 // Copy constructor: creates a copy of a FileCreatPropList object. 00062 FileCreatPropList(const FileCreatPropList& orig); 00063 00064 // Creates a copy of an existing file create property list 00065 // using the property list id. 00066 FileCreatPropList (const hid_t plist_id); 00067 00068 // Noop destructor 00069 virtual ~FileCreatPropList(); 00070 }; 00071 #ifndef H5_NO_NAMESPACE 00072 } 00073 #endif 00074 #endif

Generated on Sat Aug 21 16:36:47 2004 by doxygen 1.3.7-20040718