diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-05-18 18:40:20 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-05-18 18:40:20 (GMT) |
commit | f323a72861467a6f503b06946194b3576aa0fc7b (patch) | |
tree | cea664a28c5206dd0bcbac87823104c0400e5f71 /c++/src/H5IdComponent.cpp | |
parent | 6cecb1352220daa248bed247ffd613c92c6c9f03 (diff) | |
download | hdf5-f323a72861467a6f503b06946194b3576aa0fc7b.zip hdf5-f323a72861467a6f503b06946194b3576aa0fc7b.tar.gz hdf5-f323a72861467a6f503b06946194b3576aa0fc7b.tar.bz2 |
Purpose: Add new C++ wrappers (HDFFV-10156)
Description:
Added wrappers for H5Iis_valid, H5Ps/get_nlinks, H5Tget_create_plist,
H5Oopen, and H5Oclose
// Checks if the given ID is valid.
static bool isValid(hid_t an_id);
// Sets the number of soft or user-defined links that can be
// traversed before a failure occurs.
void setNumLinks(size_t nlinks) const;
// Gets the number of soft or user-defined link traversals allowed
size_t getNumLinks() const;
// Returns a copy of the creation property list of a datatype.
PropList getCreatePlist() const;
// Opens an object within a group or a file, i.e., root group.
hid_t openObjId(const char* name,...);
hid_t openObjId(const H5std_string& name,...);
// Closes an object opened by getObjId().
void closeObjId(hid_t obj_id) const;
// Gets general information about this file.
void getFileInfo(H5F_info2_t& file_info) const;
Platforms tested:
Linux/32 2.6 (jam)
Linux/64 (platypus)
Darwin (osx1010test)
Diffstat (limited to 'c++/src/H5IdComponent.cpp')
-rw-r--r-- | c++/src/H5IdComponent.cpp | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/c++/src/H5IdComponent.cpp b/c++/src/H5IdComponent.cpp index 7054369..a8e8ba4 100644 --- a/c++/src/H5IdComponent.cpp +++ b/c++/src/H5IdComponent.cpp @@ -163,6 +163,27 @@ H5I_type_t IdComponent::getHDFObjType() const } //-------------------------------------------------------------------------- +// Function: isValid (static) +///\brief Checks if the given ID is valid. +///\return true if the given identifier is valid, and false, otherwise. +///\par Description +/// A valid ID is one that is in use and has an application +/// reference count of at least 1. +// Programmer Binh-Minh Ribler - Mar 1, 2017 +//-------------------------------------------------------------------------- +bool IdComponent::isValid(hid_t an_id) +{ + // Call C function + htri_t ret_value = H5Iis_valid(an_id); + if (ret_value > 0) + return true; + else if (ret_value == 0) + return false; + else // Raise exception when H5Iis_valid returns a negative value + throw IdComponentException("isValid", "H5Iis_valid failed"); +} + +//-------------------------------------------------------------------------- // Function: IdComponent::operator= ///\brief Assignment operator. ///\param rhs - IN: Reference to the existing object |