 |
HDF5 C++ API
1.8.18
|
|
HDF5 C++ API
1.8.18
|
Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. More...
#include <H5Object.h>
Additional Inherited Members | |
 Public Member Functions inherited from H5::H5Location | |
| Attribute | createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const |
| Creates an attribute for a group, dataset, or named datatype. More... | |
| Attribute | createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More... | |
| Attribute | openAttribute (const char *name) const |
| Opens an attribute given its name. More... | |
| Attribute | openAttribute (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More... | |
| Attribute | openAttribute (const unsigned int idx) const |
| Opens an attribute given its index. More... | |
| void | flush (H5F_scope_t scope) const |
| Flushes all buffers associated with a location to disk. More... | |
| H5std_string | getFileName () const |
| Gets the name of the file, in which this HDF5 object belongs. More... | |
| int | getNumAttrs () const |
| Returns the number of attributes attached to this HDF5 object. More... | |
| H5G_obj_t | getObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const |
| Retrieves the type of object that an object reference points to. More... | |
| H5O_type_t | getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const |
| Retrieves the type of object that an object reference points to. More... | |
| int | iterateAttrs (attr_operator_t user_op, unsigned *idx=NULL, void *op_data=NULL) |
| Iterates a user's function over all the attributes of an H5 object, which may be a group, dataset or named datatype. More... | |
| bool | attrExists (const char *name) const |
| Checks whether the named attribute exists at this location. More... | |
| bool | attrExists (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More... | |
| void | renameAttr (const char *oldname, const char *newname) const |
| Renames the named attribute from this object. More... | |
| void | renameAttr (const H5std_string &oldname, const H5std_string &newname) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for the names. More... | |
| void | removeAttr (const char *name) const |
| Removes the named attribute from this object. More... | |
| void | removeAttr (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name. More... | |
| void | setComment (const char *name, const char *comment) const |
| Sets or resets the comment for an object specified by its name. More... | |
| void | setComment (const H5std_string &name, const H5std_string &comment) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name and comment. More... | |
| void | setComment (const char *comment) const |
| This is an overloaded member function, provided for convenience. It differs from the above function in that it doesn't take an object name. More... | |
| void | setComment (const H5std_string &comment) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for comment. More... | |
| ssize_t | getComment (const char *name, size_t buf_size, char *comment) const |
| Retrieves the comment for this location, returning its length. More... | |
| H5std_string | getComment (const char *name, size_t buf_size=0) const |
| Returns the comment as string for this location, returning its length. More... | |
| H5std_string | getComment (const H5std_string &name, size_t buf_size=0) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More... | |
| void | removeComment (const char *name) const |
| Removes the comment from an object specified by its name. More... | |
| void | removeComment (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More... | |
| void | reference (void *ref, const char *name, H5R_type_t ref_type=H5R_OBJECT) const |
| This is an overloaded function, provided for your convenience. It differs from the above function in that it does not take a DataSpace object and the reference type must be specified. More... | |
| void | reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const |
This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an H5std_string for the object's name. More... | |
| void | reference (void *ref, const char *name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const |
| Creates a reference to an HDF5 object or a dataset region. More... | |
| void | reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const |
This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More... | |
| void | dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT) |
| Dereferences a reference into an HDF5 object, given an HDF5 object. More... | |
| void | dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT) |
| Dereferences a reference into an HDF5 object, given an attribute. More... | |
| DataSpace | getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const |
| Retrieves a dataspace with the region pointed to selected. More... | |
| virtual hid_t | getId () const =0 |
| Returns an identifier. (pure virtual) More... | |
| Public Member Functions inherited from H5::IdComponent | |
| void | incRefCount (const hid_t obj_id) const |
| Increment reference counter for a given id. More... | |
| void | incRefCount () const |
| Increment reference counter for the id of this object. More... | |
| void | decRefCount (const hid_t obj_id) const |
| Decrement reference counter for a given id. More... | |
| void | decRefCount () const |
| Decrement reference counter for the id of this object. More... | |
| int | getCounter (const hid_t obj_id) const |
| Returns the reference counter for a given id. More... | |
| int | getCounter () const |
| Returns the reference counter for the id of this object. More... | |
| H5I_type_t | getHDFObjType () const |
| Returns the type of the object. It is an overloaded function of the above function. More... | |
| IdComponent & | operator= (const IdComponent &rhs) |
| Assignment operator. More... | |
| void | setId (const hid_t new_id) |
| Sets the identifier of this object to a new value. More... | |
| IdComponent (const hid_t h5_id) | |
| virtual | ~IdComponent () |
| Noop destructor. More... | |
| Static Public Member Functions inherited from H5::IdComponent | |
| static H5I_type_t | getHDFObjType (const hid_t obj_id) |
| Given an id, returns the type of the object. More... | |
| Protected Member Functions inherited from H5::H5Location | |
| virtual | ~H5Location () |
| Noop destructor. More... | |
All the wrappers in H5Object were moved to H5Location.
The HDF Group Help Desk: 
|
Copyright by
The HDF Group
and the Board of Trustees of the University of Illinois |
