summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Object.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src/H5Object.cpp')
-rw-r--r--c++/src/H5Object.cpp250
1 files changed, 136 insertions, 114 deletions
diff --git a/c++/src/H5Object.cpp b/c++/src/H5Object.cpp
index 8d3334b..cb803af 100644
--- a/c++/src/H5Object.cpp
+++ b/c++/src/H5Object.cpp
@@ -6,14 +6,13 @@
* 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. *
+ * 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 <string>
-#include "H5private.h" // for HDmemset
#include "H5Include.h"
#include "H5Exception.h"
#include "H5IdComponent.h"
@@ -42,31 +41,44 @@ namespace H5 {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
// userAttrOpWrpr interfaces between the user's function and the
// C library function H5Aiterate2
-extern "C" herr_t userAttrOpWrpr(hid_t loc_id, const char *attr_name,
- const H5A_info_t *ainfo, void *op_data)
+extern "C" {
+
+static herr_t
+userAttrOpWrpr(hid_t loc_id, const char *attr_name, const H5A_info_t *ainfo, void *op_data)
{
- H5std_string s_attr_name = H5std_string(attr_name);
- UserData4Aiterate* myData = reinterpret_cast<UserData4Aiterate *> (op_data);
+ // Unused
+ (void)loc_id;
+ (void)ainfo;
+
+ H5std_string s_attr_name = H5std_string(attr_name);
+ UserData4Aiterate *myData = reinterpret_cast<UserData4Aiterate *>(op_data);
myData->op(*myData->location, s_attr_name, myData->opData);
return 0;
}
// userVisitOpWrpr interfaces between the user's function and the
-// C library function H5Ovisit2
-extern "C" herr_t userVisitOpWrpr(hid_t obj_id, const char *attr_name,
- const H5O_info_t *obj_info, void *op_data)
+// C library function H5Ovisit3
+static herr_t
+userVisitOpWrpr(hid_t obj_id, const char *attr_name, const H5O_info2_t *obj_info, void *op_data)
{
- H5std_string s_attr_name = H5std_string(attr_name);
- UserData4Visit* myData = reinterpret_cast<UserData4Visit *> (op_data);
- int status = myData->op(*myData->obj, s_attr_name, obj_info, myData->opData);
+ // Unused
+ (void)obj_id;
+
+ H5std_string s_attr_name = H5std_string(attr_name);
+ UserData4Visit *myData = reinterpret_cast<UserData4Visit *>(op_data);
+ int status = myData->op(*myData->obj, s_attr_name, obj_info, myData->opData);
return status;
}
+} // extern "C"
+
//--------------------------------------------------------------------------
// Function: H5Object default constructor (protected)
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-H5Object::H5Object() : H5Location() {}
+H5Object::H5Object() : H5Location()
+{
+}
//--------------------------------------------------------------------------
// Function: f_Attribute_setId - friend
@@ -78,7 +90,8 @@ H5Object::H5Object() : H5Location() {}
// param new_id - IN: New id to set
// Programmer Binh-Minh Ribler - 2015
//--------------------------------------------------------------------------
-void f_Attribute_setId(Attribute* attr, hid_t new_id)
+void
+f_Attribute_setId(Attribute *attr, hid_t new_id)
{
attr->p_setId(new_id);
}
@@ -105,19 +118,20 @@ void f_Attribute_setId(Attribute* attr, hid_t new_id)
/// recreate it with this function.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-Attribute H5Object::createAttribute(const char* name, const DataType& data_type, const DataSpace& data_space, const PropList& create_plist) const
+Attribute
+H5Object::createAttribute(const char *name, const DataType &data_type, const DataSpace &data_space,
+ const PropList &create_plist) const
{
- hid_t type_id = data_type.getId();
+ hid_t type_id = data_type.getId();
hid_t space_id = data_space.getId();
hid_t plist_id = create_plist.getId();
- hid_t attr_id = H5Acreate2(getId(), name, type_id, space_id, plist_id, H5P_DEFAULT);
+ hid_t attr_id = H5Acreate2(getId(), name, type_id, space_id, plist_id, H5P_DEFAULT);
// If the attribute id is valid, create and return the Attribute object
- if (attr_id > 0)
- {
+ if (attr_id > 0) {
Attribute attr;
f_Attribute_setId(&attr, attr_id);
- return(attr);
+ return (attr);
}
else
throw AttributeIException(inMemFunc("createAttribute"), "H5Acreate2 failed");
@@ -130,9 +144,11 @@ Attribute H5Object::createAttribute(const char* name, const DataType& data_type,
/// a reference to an \c H5std_string for \a name.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-Attribute H5Object::createAttribute(const H5std_string& name, const DataType& data_type, const DataSpace& data_space, const PropList& create_plist) const
+Attribute
+H5Object::createAttribute(const H5std_string &name, const DataType &data_type, const DataSpace &data_space,
+ const PropList &create_plist) const
{
- return(createAttribute(name.c_str(), data_type, data_space, create_plist));
+ return (createAttribute(name.c_str(), data_type, data_space, create_plist));
}
//--------------------------------------------------------------------------
@@ -143,17 +159,16 @@ Attribute H5Object::createAttribute(const H5std_string& name, const DataType& da
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-Attribute H5Object::openAttribute(const char* name) const
+Attribute
+H5Object::openAttribute(const char *name) const
{
hid_t attr_id = H5Aopen(getId(), name, H5P_DEFAULT);
- if (attr_id > 0)
- {
+ if (attr_id > 0) {
Attribute attr;
f_Attribute_setId(&attr, attr_id);
- return(attr);
+ return (attr);
}
- else
- {
+ else {
throw AttributeIException(inMemFunc("openAttribute"), "H5Aopen failed");
}
}
@@ -165,9 +180,10 @@ Attribute H5Object::openAttribute(const char* name) const
/// a reference to an \c H5std_string for \a name.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-Attribute H5Object::openAttribute(const H5std_string& name) const
+Attribute
+H5Object::openAttribute(const H5std_string &name) const
{
- return(openAttribute(name.c_str()));
+ return (openAttribute(name.c_str()));
}
//--------------------------------------------------------------------------
@@ -178,18 +194,17 @@ Attribute H5Object::openAttribute(const H5std_string& name) const
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-Attribute H5Object::openAttribute(const unsigned int idx) const
+Attribute
+H5Object::openAttribute(const unsigned int idx) const
{
- hid_t attr_id = H5Aopen_by_idx(getId(), ".", H5_INDEX_CRT_ORDER,
- H5_ITER_INC, static_cast<hsize_t>(idx), H5P_DEFAULT, H5P_DEFAULT);
- if (attr_id > 0)
- {
+ hid_t attr_id = H5Aopen_by_idx(getId(), ".", H5_INDEX_CRT_ORDER, H5_ITER_INC, static_cast<hsize_t>(idx),
+ H5P_DEFAULT, H5P_DEFAULT);
+ if (attr_id > 0) {
Attribute attr;
f_Attribute_setId(&attr, attr_id);
- return(attr);
+ return (attr);
}
- else
- {
+ else {
throw AttributeIException(inMemFunc("openAttribute"), "H5Aopen_by_idx failed");
}
}
@@ -209,18 +224,19 @@ Attribute H5Object::openAttribute(const unsigned int idx) const
/// void (*)(H5::H5Location&, H5std_string, void*).
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_data)
+int
+H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_data)
{
// store the user's function and data
- UserData4Aiterate* userData = new UserData4Aiterate;
- userData->opData = op_data;
- userData->op = user_op;
- userData->location = this;
+ UserData4Aiterate *userData = new UserData4Aiterate;
+ userData->opData = op_data;
+ userData->op = user_op;
+ userData->location = this;
// call the C library routine H5Aiterate2 to iterate the attributes
hsize_t idx = _idx ? static_cast<hsize_t>(*_idx) : 0;
- int ret_value = H5Aiterate2(getId(), H5_INDEX_NAME, H5_ITER_INC, &idx,
- userAttrOpWrpr, static_cast<void *>(userData));
+ int ret_value =
+ H5Aiterate2(getId(), H5_INDEX_NAME, H5_ITER_INC, &idx, userAttrOpWrpr, static_cast<void *>(userData));
// release memory
delete userData;
@@ -229,9 +245,9 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat
/* Pass back update index value to calling code */
if (_idx)
*_idx = static_cast<unsigned>(idx);
- return(ret_value);
+ return (ret_value);
}
- else // raise exception when H5Aiterate returns a negative value
+ else // raise exception when H5Aiterate returns a negative value
throw AttributeIException(inMemFunc("iterateAttrs"), "H5Aiterate2 failed");
}
@@ -250,13 +266,11 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat
///\param *op_data - IN: User-defined pointer to data required by the
/// application for its processing of the object
///\param fields - IN: Flags specifying the fields to be retrieved
-/// to the callback op via the H5O_info_t argument.
+/// to the callback op via the H5O_info2_t argument.
/// \li \c H5O_INFO_BASIC fileno, addr, type, and rc fields
/// \li \c H5O_INFO_TIME atime, mtime, ctime, and btime fields
/// \li \c H5O_INFO_NUM_ATTRS num_attrs field
-/// \li \c H5O_INFO_HDR hdr field
-/// \li \c H5O_INFO_META_SIZE meta_size field
-/// \li \c H5O_INFO_ALL H5O_INFO_BASIC | H5O_INFO_TIME | H5O_INFO_NUM_ATTRS | H5O_INFO_HDR | H5O_INFO_META_SIZE
+/// \li \c H5O_INFO_ALL H5O_INFO_BASIC | H5O_INFO_TIME | H5O_INFO_NUM_ATTRS
///\return
/// \li On success:
/// \li the return value of the first operator that returns a positive value
@@ -266,28 +280,31 @@ int H5Object::iterateAttrs(attr_operator_t user_op, unsigned *_idx, void *op_dat
/// wrong within the library or the operator failed
///\exception H5::Exception
///\par Description
-/// For information, please refer to the H5Ovisit2 API in the HDF5
+/// For information, please refer to the H5Ovisit3 API in the HDF5
/// C Reference Manual.
// Programmer Binh-Minh Ribler - Feb, 2019
//--------------------------------------------------------------------------
-void H5Object::visit(H5_index_t idx_type, H5_iter_order_t order, visit_operator_t user_op, void *op_data, unsigned int fields)
+void
+H5Object::visit(H5_index_t idx_type, H5_iter_order_t order, visit_operator_t user_op, void *op_data,
+ unsigned int fields)
{
// Store the user's function and data
- UserData4Visit* userData = new UserData4Visit;
- userData->opData = op_data;
- userData->op = user_op;
- userData->obj = this;
+ UserData4Visit *userData = new UserData4Visit;
+ userData->opData = op_data;
+ userData->op = user_op;
+ userData->obj = this;
// Call the C API passing in op wrapper and info
- herr_t ret_value = H5Ovisit2(getId(), idx_type, order, userVisitOpWrpr, static_cast<void *>(userData), fields);
+ herr_t ret_value =
+ H5Ovisit3(getId(), idx_type, order, userVisitOpWrpr, static_cast<void *>(userData), fields);
// Release memory
delete userData;
- // Throw exception if H5Ovisit2 failed, which could be a failure in
+ // Throw exception if H5Ovisit3 failed, which could be a failure in
// the library or in the call back operator
if (ret_value < 0)
- throw Exception(inMemFunc("visit"), "H5Ovisit2 failed");
+ throw Exception(inMemFunc("visit"), "H5Ovisit3 failed");
}
//--------------------------------------------------------------------------
@@ -302,25 +319,25 @@ void H5Object::visit(H5_index_t idx_type, H5_iter_order_t order, visit_operator_
/// - version number is not one of the valid values above
// Programmer Binh-Minh Ribler - December, 2016
//--------------------------------------------------------------------------
-unsigned H5Object::objVersion() const
+unsigned
+H5Object::objVersion() const
{
- H5O_info_t objinfo;
- unsigned version = 0;
+ H5O_native_info_t objinfo;
+ unsigned version = 0;
// Use C API to get information of the object
- herr_t ret_value = H5Oget_info2(getId(), &objinfo, H5O_INFO_HDR);
+ herr_t ret_value = H5Oget_native_info(getId(), &objinfo, H5O_NATIVE_INFO_HDR);
// Throw exception if C API returns failure
if (ret_value < 0)
- throw Exception(inMemFunc("objVersion"), "H5Oget_info failed");
+ throw Exception(inMemFunc("objVersion"), "H5Oget_native_info failed");
// Return a valid version or throw an exception for invalid value
- else
- {
+ else {
version = objinfo.hdr.version;
if (version != H5O_VERSION_1 && version != H5O_VERSION_2)
throw ObjHeaderIException("objVersion", "Invalid version for object");
}
- return(version);
+ return (version);
}
//--------------------------------------------------------------------------
@@ -330,14 +347,15 @@ unsigned H5Object::objVersion() const
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-int H5Object::getNumAttrs() const
+int
+H5Object::getNumAttrs() const
{
- H5O_info_t oinfo; /* Object info */
+ H5O_info2_t oinfo; /* Object info */
- if(H5Oget_info2(getId(), &oinfo, H5O_INFO_NUM_ATTRS) < 0)
+ if (H5Oget_info3(getId(), &oinfo, H5O_INFO_NUM_ATTRS) < 0)
throw AttributeIException(inMemFunc("getNumAttrs"), "H5Oget_info failed");
else
- return(static_cast<int>(oinfo.num_attrs));
+ return (static_cast<int>(oinfo.num_attrs));
}
//--------------------------------------------------------------------------
@@ -347,7 +365,8 @@ int H5Object::getNumAttrs() const
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - 2013
//--------------------------------------------------------------------------
-bool H5Object::attrExists(const char* name) const
+bool
+H5Object::attrExists(const char *name) const
{
// Call C routine H5Aexists to determine whether an attribute exists
// at this location, which could be specified by a file, group, dataset,
@@ -355,7 +374,7 @@ bool H5Object::attrExists(const char* name) const
herr_t ret_value = H5Aexists(getId(), name);
if (ret_value > 0)
return true;
- else if(ret_value == 0)
+ else if (ret_value == 0)
return false;
else // Raise exception when H5Aexists returns a negative value
throw AttributeIException(inMemFunc("attrExists"), "H5Aexists failed");
@@ -368,9 +387,10 @@ bool H5Object::attrExists(const char* name) const
/// a reference to an \c H5std_string for \a name.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-bool H5Object::attrExists(const H5std_string& name) const
+bool
+H5Object::attrExists(const H5std_string &name) const
{
- return(attrExists(name.c_str()));
+ return (attrExists(name.c_str()));
}
//--------------------------------------------------------------------------
@@ -380,7 +400,8 @@ bool H5Object::attrExists(const H5std_string& name) const
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-void H5Object::removeAttr(const char* name) const
+void
+H5Object::removeAttr(const char *name) const
{
herr_t ret_value = H5Adelete(getId(), name);
if (ret_value < 0)
@@ -394,7 +415,8 @@ void H5Object::removeAttr(const char* name) const
/// a reference to an \c H5std_string for \a name.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-void H5Object::removeAttr(const H5std_string& name) const
+void
+H5Object::removeAttr(const H5std_string &name) const
{
removeAttr(name.c_str());
}
@@ -407,7 +429,8 @@ void H5Object::removeAttr(const H5std_string& name) const
///\exception H5::AttributeIException
// Programmer Binh-Minh Ribler - Mar, 2005
//--------------------------------------------------------------------------
-void H5Object::renameAttr(const char* oldname, const char* newname) const
+void
+H5Object::renameAttr(const char *oldname, const char *newname) const
{
herr_t ret_value = H5Arename(getId(), oldname, newname);
if (ret_value < 0)
@@ -421,9 +444,10 @@ void H5Object::renameAttr(const char* oldname, const char* newname) const
/// a reference to an \c H5std_string for the names.
// Programmer Binh-Minh Ribler - Mar, 2005
//--------------------------------------------------------------------------
-void H5Object::renameAttr(const H5std_string& oldname, const H5std_string& newname) const
+void
+H5Object::renameAttr(const H5std_string &oldname, const H5std_string &newname) const
{
- renameAttr (oldname.c_str(), newname.c_str());
+ renameAttr(oldname.c_str(), newname.c_str());
}
//--------------------------------------------------------------------------
@@ -432,22 +456,21 @@ void H5Object::renameAttr(const H5std_string& oldname, const H5std_string& newna
///\return The name of the object
// Programmer Binh-Minh Ribler - Mar, 2014
//--------------------------------------------------------------------------
-ssize_t H5Object::getObjName(char *obj_name, size_t buf_size) const
+ssize_t
+H5Object::getObjName(char *obj_name, size_t buf_size) const
{
// H5Iget_name will get buf_size-1 chars of the name to null terminate it
ssize_t name_size = H5Iget_name(getId(), obj_name, buf_size);
// If H5Iget_name returns a negative value, raise an exception
- if (name_size < 0)
- {
+ if (name_size < 0) {
throw Exception(inMemFunc("getObjName"), "H5Iget_name failed");
}
- else if (name_size == 0)
- {
+ else if (name_size == 0) {
throw Exception(inMemFunc("getObjName"), "Object must have a name, but name length is 0");
}
// Return length of the name
- return(name_size);
+ return (name_size);
}
//--------------------------------------------------------------------------
@@ -457,39 +480,37 @@ ssize_t H5Object::getObjName(char *obj_name, size_t buf_size) const
///\exception H5::Exception
// Programmer Binh-Minh Ribler - Mar, 2014
//--------------------------------------------------------------------------
-H5std_string H5Object::getObjName() const
+H5std_string
+H5Object::getObjName() const
{
- H5std_string obj_name(""); // object name to return
+ H5std_string obj_name; // object name to return
// Preliminary call to get the size of the object name
- ssize_t name_size = H5Iget_name(getId(), NULL, static_cast<size_t>(0));
+ ssize_t name_size = H5Iget_name(getId(), NULL, 0);
// If H5Iget_name failed, throw exception
- if (name_size < 0)
- {
+ if (name_size < 0) {
throw Exception(inMemFunc("getObjName"), "H5Iget_name failed");
}
- else if (name_size == 0)
- {
+ else if (name_size == 0) {
throw Exception(inMemFunc("getObjName"), "Object must have a name, but name length is 0");
}
// Object's name exists, retrieve it
- else if (name_size > 0)
- {
- char* name_C = new char[name_size+1]; // temporary C-string
- HDmemset(name_C, 0, name_size+1); // clear buffer
+ else if (name_size > 0) {
+ // Create buffer for C string
+ char *name_C = new char[name_size + 1]();
// Use overloaded function
- name_size = getObjName(name_C, name_size+1);
+ name_size = getObjName(name_C, name_size + 1);
// Convert the C object name to return
obj_name = name_C;
// Clean up resource
- delete []name_C;
+ delete[] name_C;
}
// Return object's name
- return(obj_name);
+ return (obj_name);
}
//--------------------------------------------------------------------------
@@ -505,35 +526,34 @@ H5std_string H5Object::getObjName() const
/// which case the entire name will be retrieved.
// Programmer Binh-Minh Ribler - Mar, 2014
//--------------------------------------------------------------------------
-ssize_t H5Object::getObjName(H5std_string& obj_name, size_t len) const
+ssize_t
+H5Object::getObjName(H5std_string &obj_name, size_t len) const
{
ssize_t name_size = 0;
// If no length is provided, get the entire object name
- if (len == 0)
- {
- obj_name = getObjName();
+ if (len == 0) {
+ obj_name = getObjName();
name_size = obj_name.length();
}
// If length is provided, get that number of characters in name
- else
- {
- char* name_C = new char[len+1]; // temporary C-string
- HDmemset(name_C, 0, len+1); // clear buffer
+ else {
+ // Create buffer for C string
+ char *name_C = new char[len + 1]();
// Use overloaded function
- name_size = getObjName(name_C, len+1);
+ name_size = getObjName(name_C, len + 1);
// Convert the C object name to return
obj_name = name_C;
// Clean up resource
- delete []name_C;
+ delete[] name_C;
}
// Otherwise, keep obj_name intact
// Return name size
- return(name_size);
+ return (name_size);
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
@@ -542,7 +562,9 @@ ssize_t H5Object::getObjName(H5std_string& obj_name, size_t len) const
///\brief Noop destructor.
// Programmer Binh-Minh Ribler - 2000
//--------------------------------------------------------------------------
-H5Object::~H5Object() {}
+H5Object::~H5Object()
+{
+}
#endif // DOXYGEN_SHOULD_SKIP_THIS
-} // end namespace
+} // namespace H5
generated by cgit v0.12 at 2025-09-18 22:08:24 (GMT)