hdf5_ep

// 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 COPYING file, which can be found at the root of the source code       *

 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *

 * If you do not have access to either file, you may request a copy from     *

 * help@hdfgroup.org.                                                        *

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

​

#ifndef __H5File_H

#define __H5File_H

​

namespace H5 {

​

/*! \class H5File

    \brief Class H5File represents an HDF5 file.

​

    Modification:

        May 5, 2017: In the class rearrangement of 1.8.10, H5File should have

                been moved to inherit from Group instead, because HDF5 file is

                a root group.  It is now done in 1.10 (Mar 30) and 1.8.19

                releases. -BMR

*/

//  Inheritance: Group -> CommonFG/H5Object -> H5Location -> IdComponent

class H5_DLLCPP H5File : public Group {

   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 H5std_string& name, unsigned int flags,

           const FileCreatPropList& create_plist = FileCreatPropList::DEFAULT,

           const FileAccPropList& access_plist = FileAccPropList::DEFAULT);

​

        // Open the file

        void openFile(const H5std_string& name, unsigned int flags,

            const FileAccPropList& access_plist = FileAccPropList::DEFAULT);

        void openFile(const char* name, unsigned int flags,

            const FileAccPropList& access_plist = FileAccPropList::DEFAULT);

​

        // Close this file.

        virtual void close();

​

        // Gets the access property list of this file.

        FileAccPropList getAccessPlist() const;

​