mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-04-18 17:40:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1140 in HDFFV/hdf5 from ~BMRIBLER/hdf5_bmr_cpp4:develop to develop

Browse Source 
Fixed part of HDFFV-10458: wrappers for H5Oget_info2, H5Oget_info_by_name2, and H5Oget_info_by_idx2.

* commit '3aa24435180d10aeca6493f7c1b277cfd5c73fad':
  Fixed HDFFV-10458 partially Description:     Added wrappers for H5Oget_info_by_idx2.
  Fixed comments
  Fixed HDFFV-10458 partially Description:     Added wrappers for H5Oget_info2 and H5Oget_info_by_name2.
This commit is contained in:
Binh-Minh Ribler 2018-07-17 11:56:53 -05:00
commit d95f36686b
8 changed files with 349 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
c++/src/H5Object.cpp
View File

@ -226,6 +226,130 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat
throw AttributeIException(inMemFunc("iterateAttrs"), "H5Aiterate2 failed");
}
//--------------------------------------------------------------------------
// Function: H5Object::getInfo
///\brief Retrieves information about an HDF5 object.
///\param objinfo - OUT: Struct containing the object info
///\param fields - IN: Indicates the group of information to be retrieved
///\par Description
/// Valid values of \a fields are as follows:
/// \li \c H5O_INFO_BASIC (default)
/// \li \c H5O_INFO_TIME
/// \li \c H5O_INFO_NUM_ATTRS
/// \li \c H5O_INFO_HDR
/// \li \c H5O_INFO_META_SIZE
/// \li \c H5O_INFO_ALL
// July, 2018
//--------------------------------------------------------------------------
void H5Object::getInfo(H5O_info_t& objinfo, unsigned fields) const
{
// Use C API to get information of the object
herr_t ret_value = H5Oget_info2(getId(), &objinfo, fields);
// Throw exception if C API returns failure
if (ret_value < 0)
throwException(inMemFunc("getInfo"), "H5Oget_info2 failed");
}
//--------------------------------------------------------------------------
// Function: H5Object::getInfo
///\brief Retrieves information about an HDF5 object given its name.
///\param name - IN: Name of the object to be queried - \c char *
///\param objinfo - OUT: Struct containing the object info
///\param fields - IN: Indicates the group of information to be retrieved
/// - default to H5O_INFO_BASIC
///\param lapl - IN: Link access property list
///\par Description
/// Valid values of \a fields are as follows:
/// \li \c H5O_INFO_BASIC (default)
/// \li \c H5O_INFO_TIME
/// \li \c H5O_INFO_NUM_ATTRS
/// \li \c H5O_INFO_HDR
/// \li \c H5O_INFO_META_SIZE
/// \li \c H5O_INFO_ALL
// July, 2018
//--------------------------------------------------------------------------
void H5Object::getInfo(const char* name, H5O_info_t& objinfo, unsigned fields, const LinkAccPropList& lapl) const
{
// Use C API to get information of the object
herr_t ret_value = H5Oget_info_by_name2(getId(), name, &objinfo, fields, lapl.getId());
// Throw exception if C API returns failure
if (ret_value < 0)
throwException(inMemFunc("getInfo"), "H5Oget_info_by_name2 failed");
}
//--------------------------------------------------------------------------
// Function: H5Object::getInfo
///\brief This is an overloaded member function, provided for convenience.
/// It differs from the above function in that it takes
/// a reference to an \c H5std_string for \a name.
///\param name - IN: Name of the object to be queried - \c H5std_string
///\param objinfo - OUT: Struct containing the object info
///\param fields - IN: Indicates the group of information to be retrieved
/// - default to H5O_INFO_BASIC
///\param lapl - IN: Link access property list
// July, 2018
//--------------------------------------------------------------------------
void H5Object::getInfo(const H5std_string& name, H5O_info_t& objinfo, unsigned fields, const LinkAccPropList& lapl) const
{
getInfo(name.c_str(), objinfo, fields, lapl);
}
//--------------------------------------------------------------------------
// Function: H5Object::getInfo
///\brief Retrieves information about an HDF5 object given its index.
///\param grp_name - IN: Group name where the object belongs - \c char *
///\param idx_type - IN: Type of index
///\param order - IN: Order to traverse
///\param idx - IN: Object position
///\param objinfo - OUT: Struct containing the object info
///\param fields - IN: Indicates the group of information to be retrieved
/// - default to H5O_INFO_BASIC
///\param lapl - IN: Link access property list
///\par Description
/// Valid values of \a fields are as follows:
/// \li \c H5O_INFO_BASIC (default)
/// \li \c H5O_INFO_TIME
/// \li \c H5O_INFO_NUM_ATTRS
/// \li \c H5O_INFO_HDR
/// \li \c H5O_INFO_META_SIZE
/// \li \c H5O_INFO_ALL
// July, 2018
//--------------------------------------------------------------------------
void H5Object::getInfo(const char* grp_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo, unsigned fields,
const LinkAccPropList& lapl) const
{
// Use C API to get information of the object
herr_t ret_value = H5Oget_info_by_idx2(getId(), grp_name, idx_type, order,
idx, &objinfo, fields, lapl.getId());
// Throw exception if C API returns failure
if (ret_value < 0)
throwException(inMemFunc("getInfo"), "H5Oget_info_by_idx2 failed");
}
//--------------------------------------------------------------------------
// Function: H5Object::getInfo
///\brief This is an overloaded member function, provided for convenience.
/// It differs from the above function in that it takes
/// a reference to an \c H5std_string for \a name.
///\param name - IN: Name of the object to be queried - \c H5std_string
///\param objinfo - OUT: Struct containing the object info
///\param fields - IN: Indicates a group of information to be retrieved
/// - default to H5O_INFO_BASIC
///\param lapl - IN: Link access property list
// July, 2018
//--------------------------------------------------------------------------
void H5Object::getInfo(const H5std_string& grp_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo, unsigned fields,
const LinkAccPropList& lapl) const
{
getInfo(grp_name.c_str(), idx_type, order, idx, objinfo, fields, lapl);
}
//--------------------------------------------------------------------------
// Function: H5Object::objVersion
///\brief Returns the header version of this HDF5 object.

20
c++/src/H5Object.h
View File

@ -92,6 +92,26 @@ class H5_DLLCPP H5Object : public H5Location {
// Returns an identifier.
virtual hid_t getId() const = 0;
// Returns information about an HDF5 object.
void getInfo(H5O_info_t& objinfo, unsigned fields = H5O_INFO_BASIC) const;
// Returns information about an HDF5 object, given its name.
void getInfo(const char* name, H5O_info_t& objinfo,
unsigned fields = H5O_INFO_BASIC,
const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const;
void getInfo(const H5std_string& name, H5O_info_t& objinfo,
unsigned fields = H5O_INFO_BASIC,
const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const;
// Retrieves information about an HDF5 object, given its index.
void getInfo(const char* grp_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo,
unsigned fields = H5O_INFO_BASIC,
const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const;
void getInfo(const H5std_string& grp_name, H5_index_t idx_type,
H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo,
unsigned fields = H5O_INFO_BASIC,
const LinkAccPropList& lapl = LinkAccPropList::DEFAULT) const;
// Gets the name of this HDF5 object, i.e., Group, DataSet, or
// DataType.
ssize_t getObjName(char *obj_name, size_t buf_size = 0) const;

62
c++/test/dsets.cpp
View File

@ -1114,6 +1114,67 @@ static herr_t test_types(H5File& file)
}
} // test_types
/*-------------------------------------------------------------------------
* Function: test_getinfo
*
* Purpose Tests getInfo()
*
* Return Success: 0
*
* Failure: -1
*
* July, 2018
*-------------------------------------------------------------------------
*/
static herr_t test_getinfo(H5File& file)
{
SUBTEST("Getting object information");
try {
// Create a data space
hsize_t dims[2];
dims[0] = 256;
dims[1] = 512;
DataSpace space (2, dims, NULL);
// Create a dataset using the default dataset creation properties.
// We're not sure what they are, so we won't check.
DataSet dataset(file.openDataSet(DSET_CHUNKED_NAME));
// Get dataset header info
H5O_info_t oinfo;
HDmemset(&oinfo, 0, sizeof(oinfo));
dataset.getInfo(oinfo, H5O_INFO_HDR);
verify_val(oinfo.hdr.nchunks, 1, "DataSet::getInfo", __LINE__, __FILE__);
dataset.close();
// Open the dataset we created above and then close it. This is one
// way to open an existing dataset for accessing.
dataset = file.openDataSet(DSET_DEFAULT_NAME);
HDmemset(&oinfo, 0, sizeof(oinfo));
dataset.getInfo(oinfo, H5O_INFO_ALL);
verify_val(oinfo.hdr.nchunks, 1, "DataSet::getInfo", __LINE__, __FILE__);
dataset.close();
PASSED();
return 0;
} // outer most try block
catch (InvalidActionException& E)
{
cerr << " FAILED" << endl;
cerr << " <<< " << E.getDetailMsg() << " >>>" << endl << endl;
return -1;
}
// catch all other exceptions
catch (Exception& E)
{
issue_fail_msg("test_getinfo", __LINE__, __FILE__);
return -1;
}
} // test_getinfo
/*-------------------------------------------------------------------------
* Function: test_virtual
@ -1237,6 +1298,7 @@ void test_dset()
nerrors += test_create(file) < 0 ? 1:0;
nerrors += test_simple_io(file) < 0 ? 1:0;
nerrors += test_getinfo(file) < 0 ? 1:0;
nerrors += test_tconv(file) < 0 ? 1:0;
nerrors += test_compression(file) < 0 ? 1:0;
nerrors += test_nbit_compression(file) < 0 ? 1:0;

19
c++/test/tattr.cpp
View File

@ -518,6 +518,12 @@ static void test_attr_basic_read()
int num_attrs = dataset.getNumAttrs();
verify_val(num_attrs, 3, "DataSet::getNumAttrs", __LINE__, __FILE__);
// Verify the correct number of attributes another way
H5O_info_t oinfo;
HDmemset(&oinfo, 0, sizeof(oinfo));
dataset.getInfo(oinfo, H5O_INFO_NUM_ATTRS);
verify_val(oinfo.num_attrs, 3, "DataSet::getInfo", __LINE__, __FILE__);
// Open an attribute for the dataset
Attribute ds_attr=dataset.openAttribute(ATTR1_NAME);
@ -538,7 +544,12 @@ static void test_attr_basic_read()
// Verify the correct number of attributes
num_attrs = group.getNumAttrs();
verify_val(num_attrs, 1, "H5Group::getNumAttrs", __LINE__, __FILE__);
verify_val(num_attrs, 1, "Group::getNumAttrs", __LINE__, __FILE__);
// Verify the correct number of attributes another way
HDmemset(&oinfo, 0, sizeof(oinfo));
group.getInfo(oinfo, H5O_INFO_NUM_ATTRS);
verify_val(oinfo.num_attrs, 1, "Group::getInfo", __LINE__, __FILE__);
// Open an attribute for the group
Attribute gr_attr = group.openAttribute(ATTR2_NAME);
@ -658,6 +669,12 @@ static void test_attr_compound_read()
int num_attrs = dataset.getNumAttrs();
verify_val(num_attrs, 1, "DataSet::getNumAttrs", __LINE__, __FILE__);
// Verify the correct number of attributes another way
H5O_info_t oinfo;
HDmemset(&oinfo, 0, sizeof(oinfo));
dataset.getInfo(oinfo, H5O_INFO_NUM_ATTRS);
verify_val(oinfo.num_attrs, 1, "DataSet::getInfo", __LINE__, __FILE__);
// Open 1st attribute for the dataset
Attribute attr = dataset.openAttribute((unsigned)0);

14
c++/test/tfile.cpp
View File

@ -657,8 +657,15 @@ static void test_libver_bounds_real(
unsigned obj_version = file.childObjVersion(ROOTGROUP);
verify_val(obj_version, oh_vers_create, "H5File::childObjVersion", __LINE__, __FILE__);
// Verify object header version another way
H5O_info_t oinfo;
HDmemset(&oinfo, 0, sizeof(oinfo));
file.getInfo(oinfo, H5O_INFO_HDR);
verify_val(oinfo.hdr.version, oh_vers_create, "H5File::getInfo", __LINE__, __FILE__);
/*
* Reopen the file and make sure the root group still has the correct version
* Reopen the file and make sure the root group still has the correct
* version
*/
file.close();
@ -678,6 +685,11 @@ static void test_libver_bounds_real(
obj_version = group.objVersion();
verify_val(obj_version, oh_vers_mod, "Group::objVersion", __LINE__, __FILE__);
// Verify object header version another way
HDmemset(&oinfo, 0, sizeof(oinfo));
group.getInfo(oinfo, H5O_INFO_HDR);
verify_val(oinfo.hdr.version, oh_vers_mod, "Group::getInfo", __LINE__, __FILE__);
group.close(); // close "/G1"
/*

7
c++/test/tlinks.cpp
View File

@ -515,7 +515,7 @@ test_lcpl(hid_t fapl_id, hbool_t new_format)
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_num_links()", __LINE__, __FILE__, E.getCDetailMsg());
issue_fail_msg("test_lcpl()", __LINE__, __FILE__, E.getCDetailMsg());
}
} // end test_lcpl()
@ -657,7 +657,7 @@ test_move(hid_t fapl_id, hbool_t new_format)
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_num_links()", __LINE__, __FILE__, E.getCDetailMsg());
issue_fail_msg("test_move()", __LINE__, __FILE__, E.getCDetailMsg());
}
} // test_move
@ -792,7 +792,7 @@ static void test_copy(hid_t fapl_id, hbool_t new_format)
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_num_links()", __LINE__, __FILE__, E.getCDetailMsg());
issue_fail_msg("test_copy()", __LINE__, __FILE__, E.getCDetailMsg());
}
} // test_copy
@ -892,6 +892,7 @@ void test_links()
/* General tests... (on both old & new format groups */
// FileAccPropList may be passed in instead of fapl id
test_basic_links(my_fapl_id, new_format);
test_num_links(my_fapl_id, new_format);
test_move(my_fapl_id, new_format);
test_copy(my_fapl_id, new_format);
test_lcpl(my_fapl_id, new_format);

98
c++/test/tobject.cpp
View File

@ -523,19 +523,106 @@ static void test_open_object_header()
cerr << " in Exception" << endl;
issue_fail_msg("test_file_name()", __LINE__, __FILE__, E.getCDetailMsg());
}
} /* test_open_object_header() */
} // test_open_object_header
/*-------------------------------------------------------------------------
* Function: test_objects
* Function: test_getobjectinfo_same_file
*
* Purpose Test that querying the object info for objects in the same
* file will return the same file "number".
*
* Return None
*
* July, 2018
*-------------------------------------------------------------------------
*/
const H5std_string FILE_OBJINFO("tobject_getinfo.h5");
const H5std_string GROUP1NAME("group1");
const H5std_string GROUP2NAME("group2");
static void test_getobjectinfo_same_file()
{
H5O_info_t oinfo1, oinfo2; /* Object info structs */
// Output message about test being performed
SUBTEST("Group::getInfo");
try {
// Create a new HDF5 file
H5File file1(FILE_OBJINFO, H5F_ACC_TRUNC);
// Create two groups in the file
Group grp1(file1.createGroup(GROUP1NAME));
Group grp2(file1.createGroup(GROUP2NAME));
// Reset object info
HDmemset(&oinfo1, 0, sizeof(oinfo1));
HDmemset(&oinfo2, 0, sizeof(oinfo2));
// Query the info of two groups and verify that they have the same
// file number
grp1.getInfo(oinfo1);
grp2.getInfo(oinfo2);
verify_val(oinfo1.fileno, oinfo2.fileno, "file number from getInfo", __LINE__, __FILE__);
// Close groups and file
grp1.close();
grp2.close();
file1.close();
// Open the file twice
file1.openFile(FILE_OBJINFO, H5F_ACC_RDWR);
H5File file2(FILE_OBJINFO, H5F_ACC_RDWR);
// Create two groups in the file
grp1 = file1.openGroup(GROUP1NAME);
grp2 = file2.openGroup(GROUP2NAME);
// Reset object info
HDmemset(&oinfo1, 0, sizeof(oinfo1));
HDmemset(&oinfo2, 0, sizeof(oinfo2));
// Query the info of two groups and verify that they have the same
// file number
grp1.getInfo(oinfo1);
grp2.getInfo(oinfo2);
verify_val(oinfo1.fileno, oinfo2.fileno, "file number from getInfo", __LINE__, __FILE__);
// Reset object info
HDmemset(&oinfo1, 0, sizeof(oinfo1));
HDmemset(&oinfo2, 0, sizeof(oinfo2));
file1.getInfo(GROUP1NAME, oinfo1);
file1.getInfo(GROUP2NAME, oinfo2);
verify_val(oinfo1.fileno, oinfo2.fileno, "file number from getObjectInfo", __LINE__, __FILE__);
// Close groups and files
grp1.close();
grp2.close();
file1.close();
file2.close();
PASSED();
} // end of try block
// catch all other exceptions
catch (Exception& E)
{
cerr << " in Exception " << E.getCFuncName() << "detail: " << E.getCDetailMsg() << endl;
issue_fail_msg("test_file_name()", __LINE__, __FILE__, E.getCDetailMsg());
}
} // test_h5o_getinfo_same_file
/*-------------------------------------------------------------------------
* Function: test_object
*
* Purpose Tests HDF5 object related functionality
*
* Return Success: 0
* Failure: -1
*
* Programmer Binh-Minh Ribler
* Friday, Mar 4, 2014
* March 4, 2014
*-------------------------------------------------------------------------
*/
extern "C"
@ -549,8 +636,9 @@ void test_object()
test_get_objname_ontypes(); // Test get object name from types
test_get_objtype(); // Test get object type
test_open_object_header(); // Test object header functions (H5O)
test_getobjectinfo_same_file(); // Test object info in same file
} // test_objects
} // test_object
/*-------------------------------------------------------------------------

15
c++/test/trefer.cpp
View File

@ -481,6 +481,21 @@ static void test_reference_group()
fname = group.getFileName();
verify_val(fname, FILE1, "H5Group::getFileName",__LINE__,__FILE__);
// Check object type using Group::getInfo()
H5O_info_t oinfo;
HDmemset(&oinfo, 0, sizeof(oinfo));
group.getInfo(".", H5_INDEX_NAME, H5_ITER_INC, (hsize_t)0, oinfo);
verify_val(oinfo.type, H5O_TYPE_DATASET, "Group::getInfo",__LINE__,__FILE__);
// Check for out of bound query by index
try {
HDmemset(&oinfo, 0, sizeof(oinfo));
group.getInfo(".", H5_INDEX_NAME, H5_ITER_INC, (hsize_t)9, oinfo);
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("Group::getInfo", "Out of bound index.");
} catch (Exception& err) {} // do nothing, failure expected
// Unlink one of the objects in the dereferenced group, and re-check
refgroup.unlink(GROUPNAME2);
nobjs = refgroup.getNumObjs();