// 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 __Group_H
#define __Group_H

namespace H5 {

/*! \class Group
    \brief Class Group represents an HDF5 group.
*/
//  Inheritance: CommonFG/H5Object -> H5Location -> IdComponent
class H5_DLLCPP Group : public H5Object, public CommonFG {
   public:
        // Close this group.
        virtual void close();

        ///\brief Returns this class name.
        virtual H5std_string fromClass () const { return("Group"); }

        // Throw group exception.
        virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const;

        // for CommonFG to get the file id.
        virtual hid_t getLocId() const;

        // Creates a group by way of dereference.
        Group(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
        // Removed in 1.10.1, because H5Location is baseclass
//        Group(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);

        // Returns the number of objects in this group.
        hsize_t getNumObjs() const;

        // Opens an object within a group or a file, i.e., root group.
        hid_t getObjId(const char* name, const PropList& plist = PropList::DEFAULT) const;
        hid_t getObjId(const H5std_string& name, const PropList& plist = PropList::DEFAULT) const;

        // Closes an object opened by getObjId().
        void closeObjId(hid_t obj_id) const;

        /*** For H5L API ***/

        // Creates a soft link from link_name to target_name.
        void newLink(const char *target_name, const char *link_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;
        void newLink(const H5std_string& target_name,
             const H5std_string& link_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;

        // Creates a hard link from new_name to curr_name.
        void newLink(const char *curr_name,
             const Group& new_loc, const char *new_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;
        void newLink(const H5std_string& curr_name,
             const Group& new_loc, const H5std_string& new_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;

        // Creates a hard link from new_name to curr_name in same location.
        void newLink(const char *curr_name,
             const hid_t same_loc, const char *new_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;
        void newLink(const H5std_string& curr_name,
             const hid_t same_loc, const H5std_string& new_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;

        // Copy an object from a group of file to another.
        void copyLink(const char *src_name,
             const Group& dst, const char *dst_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;
        void copyLink(const H5std_string& src_name,
             const Group& dst, const H5std_string& dst_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;

        // Copy an object from a group of file to the same location.
        void copyLink(const char *src_name, const char *dst_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;
        void copyLink(const H5std_string& src_name,
             const H5std_string& dst_name,
             const PropList& lcpl = PropList::DEFAULT,
             const PropList& lapl = PropList::DEFAULT) const;

        // Rename an object in a group or file to a new location.
        void moveLink(const char* src_name,
            const Group& dst, const char* dst_name, 
            const PropList& lcpl = PropList::DEFAULT,
            const PropList& lapl = PropList::DEFAULT) const;
        void moveLink(const H5std_string& src_name,
            const Group& dst, const H5std_string& dst_name,
            const PropList& lcpl = PropList::DEFAULT,
            const PropList& lapl = PropList::DEFAULT) const;

        // Rename an object in a group or file to the same location.
        void moveLink(const char* src_name, const char* dst_name, 
            const PropList& lcpl = PropList::DEFAULT,
            const PropList& lapl = PropList::DEFAULT) const;
        void moveLink(const H5std_string& src_name,
            const H5std_string& dst_name,
            const PropList& lcpl = PropList::DEFAULT,
            const PropList& lapl = PropList::DEFAULT) const;

        // default constructor
        Group();

        // Copy constructor: makes a copy of the original object
        Group(const Group& original);

        // Gets the group id.
        virtual hid_t getId() const;

        // Destructor
        virtual ~Group();

        // Creates a copy of an existing group using its id.
        Group(const hid_t group_id);

   protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        // Sets the group id.
        virtual void p_setId(const hid_t new_id);
#endif // DOXYGEN_SHOULD_SKIP_THIS

   private:
        hid_t id;    // HDF5 group id

}; // end of Group
} // namespace H5

#endif // __Group_H