hdf5_ep

// C++ informative line for the emacs editor: -*- C++ -*-

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

  * 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *

  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *

  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

​

#ifndef _H5File_H

#define _H5File_H

​

#ifndef H5_NO_NAMESPACE

namespace H5 {

#endif

​

class H5_DLLCPP H5File : public IdComponent, public CommonFG {

   public:

    // Creates or opens an HDF5 file.

    H5File( const char* name, unsigned int flags,

       const FileCreatPropList& create_plist = FileCreatPropList::DEFAULT,

       const FileAccPropList& access_plist = FileAccPropList::DEFAULT );

    H5File( const string& name, unsigned int flags,

       const FileCreatPropList& create_plist = FileCreatPropList::DEFAULT,

       const FileAccPropList& access_plist = FileAccPropList::DEFAULT );

​

        // Close this file.

        virtual void close();

​

    // Gets the access property list of this file.

    FileAccPropList getAccessPlist() const;

​

    // Gets the creation property list of this file.

    FileCreatPropList getCreatePlist() const;

​

    // Gets the name of this file.

    string getFileName() const;

​

        // Retrieves the file size of an opened file.

        hsize_t getFileSize() const;

​

    // Returns the amount of free space in the file.

    hssize_t getFreeSpace() const;

​

    // Returns the number of opened object IDs (files, datasets, groups