You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
291 lines
11 KiB
291 lines
11 KiB
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#include <iostream>
|
|
#include <string>
|
|
|
|
#include "H5Include.h"
|
|
#include "H5Exception.h"
|
|
#include "H5IdComponent.h"
|
|
#include "H5PropList.h"
|
|
#include "H5FaccProp.h"
|
|
#include "H5FcreatProp.h"
|
|
#include "H5OcreatProp.h"
|
|
#include "H5DcreatProp.h"
|
|
#include "H5DxferProp.h"
|
|
#include "H5LcreatProp.h"
|
|
#include "H5LaccProp.h"
|
|
#include "H5DaccProp.h"
|
|
#include "H5Location.h"
|
|
#include "H5Object.h"
|
|
#include "H5AbstractDs.h"
|
|
#include "H5DataSpace.h"
|
|
#include "H5DataSet.h"
|
|
#include "H5CommonFG.h"
|
|
#include "H5Attribute.h"
|
|
#include "H5Group.h"
|
|
#include "H5File.h"
|
|
#include "H5Alltypes.h"
|
|
|
|
namespace H5 {
|
|
using std::cerr;
|
|
using std::endl;
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group default constructor
|
|
///\brief Default constructor: creates a stub Group.
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
//--------------------------------------------------------------------------
|
|
Group::Group() : H5Object(), CommonFG(), id(H5I_INVALID_HID)
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group copy constructor
|
|
///\brief Copy constructor: same HDF5 object as \a original
|
|
///\param original - IN: Original group to copy
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
//--------------------------------------------------------------------------
|
|
Group::Group(const Group &original) : H5Object(), CommonFG(), id(original.id)
|
|
{
|
|
incRefCount(); // increment number of references to this id
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::closeObjId
|
|
///\brief Closes an object, which was opened with Group::getObjId
|
|
///
|
|
///\exception H5::FileIException or H5::GroupIException
|
|
// Programmer Binh-Minh Ribler - March, 2017
|
|
//--------------------------------------------------------------------------
|
|
void
|
|
Group::closeObjId(hid_t obj_id) const
|
|
{
|
|
herr_t ret_value = H5Oclose(obj_id);
|
|
if (ret_value < 0) {
|
|
throwException("Group::closeObjId", "H5Oclose failed");
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::getLocId
|
|
// Purpose: Get the id of this group
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
// Description
|
|
// This function is a redefinition of CommonFG::getLocId. It
|
|
// is used by CommonFG member functions to get the file id.
|
|
// Deprecated:
|
|
// Aug 18, 2016 -BMR
|
|
// After HDFFV-9920, the Group's methods can use getId() and
|
|
// getLocId() is kept for backward compatibility.
|
|
//--------------------------------------------------------------------------
|
|
hid_t
|
|
Group::getLocId() const
|
|
{
|
|
return (getId());
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group overloaded constructor
|
|
///\brief Creates a Group object using the id of an existing group.
|
|
///\param existing_id - IN: Id of an existing group
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
//--------------------------------------------------------------------------
|
|
Group::Group(const hid_t existing_id) : H5Object(), CommonFG(), id(existing_id)
|
|
{
|
|
incRefCount(); // increment number of references to this id
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group overload constructor - dereference
|
|
///\brief Given a reference, ref, to an hdf5 group, creates a Group object
|
|
///\param loc - IN: Specifying location referenced object is in
|
|
///\param ref - IN: Reference pointer
|
|
///\param ref_type - IN: Reference type - default to H5R_OBJECT
|
|
///\param plist - IN: Property list - default to PropList::DEFAULT
|
|
///\exception H5::ReferenceException
|
|
///\par Description
|
|
/// \c obj can be DataSet, Group, or named DataType, that
|
|
/// is a datatype that has been named by DataType::commit.
|
|
// Programmer Binh-Minh Ribler - Oct, 2006
|
|
//--------------------------------------------------------------------------
|
|
Group::Group(const H5Location &loc, const void *ref, H5R_type_t ref_type, const PropList &plist)
|
|
: H5Object(), CommonFG(), id(H5I_INVALID_HID)
|
|
{
|
|
id = H5Location::p_dereference(loc.getId(), ref, ref_type, plist, "constructor - by dereference");
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::getNumObjs
|
|
///\brief Returns the number of objects in this group.
|
|
///\return Number of objects
|
|
///\exception H5::FileIException or H5::GroupIException
|
|
// Programmer Binh-Minh Ribler - January, 2003
|
|
//--------------------------------------------------------------------------
|
|
hsize_t
|
|
Group::getNumObjs() const
|
|
{
|
|
H5G_info_t ginfo; // Group information
|
|
|
|
herr_t ret_value = H5Gget_info(getId(), &ginfo);
|
|
if (ret_value < 0)
|
|
throwException("getNumObjs", "H5Gget_info failed");
|
|
return (ginfo.nlinks);
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::getObjId
|
|
///\brief Opens an object via object header.
|
|
///\param obj_name - IN: Path to the object
|
|
///\param plist - IN: Access property list for the link pointing to
|
|
/// the object
|
|
///\exception H5::FileIException or H5::GroupIException
|
|
///\par Description
|
|
/// This function opens an object in a group or file, using
|
|
/// H5Oopen. Thus, an object can be opened without knowing
|
|
/// the object's type.
|
|
// Programmer Binh-Minh Ribler - March, 2017
|
|
//--------------------------------------------------------------------------
|
|
hid_t
|
|
Group::getObjId(const char *obj_name, const PropList &plist) const
|
|
{
|
|
hid_t ret_value = H5Oopen(getId(), obj_name, plist.getId());
|
|
if (ret_value < 0) {
|
|
throwException("Group::getObjId", "H5Oopen failed");
|
|
}
|
|
return (ret_value);
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::getObjId
|
|
///\brief This is an overloaded member function, provided for convenience.
|
|
/// It takes a reference to a \c H5std_string for the object's name.
|
|
///\param obj_name - IN: Path to the object
|
|
///\param plist - IN: Access property list for the link pointing to
|
|
/// the object
|
|
///\exception H5::FileIException or H5::GroupIException
|
|
// Programmer Binh-Minh Ribler - March, 2017
|
|
//--------------------------------------------------------------------------
|
|
hid_t
|
|
Group::getObjId(const H5std_string &obj_name, const PropList &plist) const
|
|
{
|
|
return (getObjId(obj_name.c_str(), plist));
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::getId
|
|
///\brief Get the id of this group
|
|
///\return Group identifier
|
|
// Modification:
|
|
// May 2008 - BMR
|
|
// Class hierarchy is revised to address bugzilla 1068. Class
|
|
// AbstractDS and Attribute are moved out of H5Object. In
|
|
// addition, member IdComponent::id is moved into subclasses, and
|
|
// IdComponent::getId now becomes pure virtual function.
|
|
// Programmer Binh-Minh Ribler - May, 2008
|
|
//--------------------------------------------------------------------------
|
|
hid_t
|
|
Group::getId() const
|
|
{
|
|
return (id);
|
|
}
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::p_setId
|
|
///\brief Sets the identifier of this object to a new value.
|
|
///
|
|
///\exception H5::IdComponentException when the attempt to close the HDF5
|
|
/// object fails
|
|
// Description:
|
|
// The underlying reference counting in the C library ensures
|
|
// that the current valid id of this object is properly closed.
|
|
// Then the object's id is reset to the new id.
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
//--------------------------------------------------------------------------
|
|
void
|
|
Group::p_setId(const hid_t new_id)
|
|
{
|
|
// handling references to this old id
|
|
try {
|
|
close();
|
|
}
|
|
catch (Exception &close_error) {
|
|
throwException("Group::p_setId", close_error.getDetailMsg());
|
|
}
|
|
// reset object's id to the given id
|
|
id = new_id;
|
|
}
|
|
#endif // DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::close
|
|
///\brief Closes this group.
|
|
///
|
|
///\exception H5::GroupIException
|
|
// Programmer Binh-Minh Ribler - Mar 9, 2005
|
|
//--------------------------------------------------------------------------
|
|
void
|
|
Group::close()
|
|
{
|
|
if (p_valid_id(id)) {
|
|
herr_t ret_value = H5Gclose(id);
|
|
if (ret_value < 0) {
|
|
throwException("Group::close", "H5Gclose failed");
|
|
}
|
|
// reset the id
|
|
id = H5I_INVALID_HID;
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group::throwException
|
|
///\brief Throws H5::GroupIException.
|
|
///\param func_name - Name of the function where failure occurs
|
|
///\param msg - Message describing the failure
|
|
///\exception H5::GroupIException
|
|
// Description
|
|
// This function is also used in H5Location's methods so that
|
|
// proper exception can be thrown for file or group. The
|
|
// "Group::" will be inserted to indicate the function called is
|
|
// an implementation of Group.
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
//--------------------------------------------------------------------------
|
|
void
|
|
Group::throwException(const H5std_string &func_name, const H5std_string &msg) const
|
|
{
|
|
H5std_string full_name = func_name;
|
|
full_name.insert(0, "Group::");
|
|
throw GroupIException(full_name, msg);
|
|
}
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Function: Group destructor
|
|
///\brief Properly terminates access to this group.
|
|
// Programmer Binh-Minh Ribler - 2000
|
|
// Modification
|
|
// - Replaced resetIdComponent() with decRefCount() to use C
|
|
// library ID reference counting mechanism - BMR, Feb 20, 2005
|
|
// - Replaced decRefCount with close() to let the C library
|
|
// handle the reference counting - BMR, Jun 1, 2006
|
|
//--------------------------------------------------------------------------
|
|
Group::~Group()
|
|
{
|
|
try {
|
|
close();
|
|
}
|
|
catch (Exception &close_error) {
|
|
cerr << "Group::~Group - " << close_error.getDetailMsg() << endl;
|
|
}
|
|
}
|
|
|
|
} // namespace H5
|
|
|