H5FcreatProp.h

// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef __H5FileCreatPropList_H
#define __H5FileCreatPropList_H

namespace H5 {

class H5_DLLCPP FileCreatPropList : public PropList {
   public:
    static const FileCreatPropList& DEFAULT;

    // Creates a file create property list.
    FileCreatPropList();

    // Retrieves version information for various parts of a file.
    void getVersion( unsigned& super, unsigned& freelist, unsigned& stab, unsigned& shhdr ) const;

    // Sets the userblock size field of a file creation property list.
    void setUserblock( hsize_t size ) const;

    // Gets the size of a user block in this file creation property list.
    hsize_t getUserblock() const;

    // Retrieves the size-of address and size quantities stored in a
    // file according to this file creation property list.
    void getSizes( size_t& sizeof_addr, size_t& sizeof_size ) const;

    // Sets file size-of addresses and sizes.
    void setSizes( size_t sizeof_addr = 4, size_t sizeof_size = 4 ) const;

    // Retrieves the size of the symbol table B-tree 1/2 rank and the
    // symbol table leaf node 1/2 size.
    void getSymk( unsigned& int_nodes_k, unsigned& leaf_nodes_k ) const;

    // Sets the size of parameters used to control the symbol table nodes.
    void setSymk( unsigned int_nodes_k, unsigned leaf_nodes_k ) const;

    // Returns the 1/2 rank of an indexed storage B-tree.
    unsigned getIstorek() const;

    // Sets the size of parameter used to control the B-trees for
    // indexing chunked datasets.
    void setIstorek( unsigned ik ) const;

    virtual H5std_string fromClass () const { return("FileCreatPropList"); }

    // Copy constructor: creates a copy of a FileCreatPropList object.
    FileCreatPropList(const FileCreatPropList& orig);

    // Creates a copy of an existing file create property list
    // using the property list id.
    FileCreatPropList (const hid_t plist_id);

    // Noop destructor
    virtual ~FileCreatPropList();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    // Deletes the global constant, should only be used by the library
    static void deleteConstants();

    private:
    static FileCreatPropList* DEFAULT_;

    // Creates the global constant, should only be used by the library
    static FileCreatPropList* getConstant();

#endif // DOXYGEN_SHOULD_SKIP_THIS

};
}
#endif // __H5FileCreatPropList_H