HDF5 C++ API  1.8.20
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
H5::H5Object Class Reference

Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. More...

#include <H5Object.h>

Inheritance diagram for H5::H5Object:
H5::H5Location H5::IdComponent H5::DataSet H5::DataType H5::Group H5::ArrayType H5::AtomType H5::CompType H5::EnumType H5::VarLenType H5::H5File H5::FloatType H5::IntType H5::PredType H5::StrType

Public Member Functions

Attribute createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 Deprecated - replaced by H5Object::createAttribute. More...
 
Attribute createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 Deprecated - replaced by H5Object::createAttribute. More...
 
Attribute openAttribute (const char *name) const
 Deprecated - replaced by H5Object::openAttribute. More...
 
Attribute openAttribute (const H5std_string &name) const
 Deprecated - replaced by H5Object::openAttribute. More...
 
Attribute openAttribute (const unsigned int idx) const
 Deprecated - replaced by H5Object::openAttribute. More...
 
bool attrExists (const char *name) const
 Deprecated - replaced by H5Object::attrExists() More...
 
bool attrExists (const H5std_string &name) const
 Deprecated - replaced by H5Object::attrExists() More...
 
void renameAttr (const char *oldname, const char *newname) const
 Deprecated - replaced by H5Object::renameAttr() More...
 
void renameAttr (const H5std_string &oldname, const H5std_string &newname) const
 Deprecated - replaced by H5Object::renameAttr() More...
 
void removeAttr (const char *name) const
 Deprecated - replaced by H5Object::removeAttr() More...
 
void removeAttr (const H5std_string &name) const
 Deprecated - replaced by H5Object::removeAttr() More...
 
int getNumAttrs () const
 
ssize_t getObjName (char *obj_name, size_t buf_size=0) const
 
ssize_t getObjName (H5std_string &obj_name, size_t len=0) const
 
H5std_string getObjName () const
 
- Public Member Functions inherited from H5::H5Location
bool nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 Checks if a link of a given name exists in a location. More...
 
bool nameExists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 Checks if a link of a given name exists in a location. 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...
 
void getObjectInfo (H5O_info_t *oinfo) const
 Retrieve information about an object, specified by location.

Exceptions
H5::LocationException.
More...
 
void getObjectInfo (const char *name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 Retrieve information about an object, specified by name.

Exceptions
H5::LocationException.
More...
 
void getObjectInfo (const H5std_string &name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 Retrieve information about an object, specified by name.

Exceptions
H5::LocationException.
More...
 
int getNumAttrs () const
 Deprecated - replaced by H5Object::getNumAttrs() 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...
 
unsigned objVersion () const
 Returns the header version of this HDF5 object. 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...
 
hid_t openObjId (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 Opens an object without knowing the object type. More...
 
hid_t openObjId (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string for the object's path. More...
 
void closeObjId (hid_t obj_id) const
 Closes an object, which was opened with H5Location::openObjId. More...
 
virtual hid_t getId () const =0
 Returns an identifier. (pure virtual) More...
 
virtual 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...
 
- 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...
 
IdComponentoperator= (const IdComponent &rhs)
 Assignment operator. More...
 
void setId (const hid_t new_id)
 Sets the identifier of this object to a new value. More...
 
virtual ~IdComponent ()
 Noop destructor. More...
 

Additional Inherited Members

- 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...
 
static bool isValid (hid_t an_id)
 Checks if the given ID is valid. More...
 
- Protected Member Functions inherited from H5::H5Location
virtual ~H5Location ()
 Noop destructor. More...
 

Detailed Description

Modification: Sept 18, 2012: Added class H5Location in between IdComponent and H5Object. An H5File now inherits from H5Location. All HDF5 wrappers in H5Object are moved up to H5Location. H5Object is left mostly empty for future wrappers that are only for group, dataset, and named datatype. Note that the reason for adding H5Location instead of simply moving H5File to be under H5Object is H5File is not an HDF5 object, and renaming H5Object to H5Location will risk breaking user applications. -BMR Apr 2, 2014: Added wrapper getObjName for H5Iget_name -BMR

Member Function Documentation

bool H5::H5Object::attrExists ( const char *  name) const
virtual
Parameters
name- IN: Name of the attribute to be queried
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.

bool H5::H5Object::attrExists ( const H5std_string &  name) const
virtual
Parameters
name- IN: Name of the attribute to be queried

Reimplemented from H5::H5Location.

Attribute H5::H5Object::createAttribute ( const char *  name,
const DataType data_type,
const DataSpace data_space,
const PropList create_plist = PropList::DEFAULT 
) const
virtual
Parameters
name- IN: Name of the attribute
data_type- IN: Datatype for the attribute
data_space- IN: Dataspace for the attribute - only simple dataspaces are allowed at this time
create_plist- IN: Creation property list - default to PropList::DEFAULT
Returns
Attribute instance
Exceptions
H5::AttributeIException
Description
The attribute name specified in name must be unique. Attempting to create an attribute with the same name as an existing attribute will raise an exception, leaving the pre-existing attribute intact. To overwrite an existing attribute with a new attribute of the same name, first delete the existing one with H5Location::removeAttr, then recreate it with this function.

Reimplemented from H5::H5Location.

Attribute H5::H5Object::createAttribute ( const H5std_string &  name,
const DataType data_type,
const DataSpace data_space,
const PropList create_plist = PropList::DEFAULT 
) const
virtual

It differs from the above function in that it takes a reference to an H5std_string for name.

Reimplemented from H5::H5Location.

int H5::H5Object::getNumAttrs ( ) const
ssize_t H5::H5Object::getObjName ( char *  obj_name,
size_t  buf_size = 0 
) const
ssize_t H5::H5Object::getObjName ( H5std_string &  obj_name,
size_t  len = 0 
) const
H5std_string H5::H5Object::getObjName ( ) const
Attribute H5::H5Object::openAttribute ( const char *  name) const
virtual
Parameters
name- IN: Name of the attribute
Returns
Attribute instance
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.

Attribute H5::H5Object::openAttribute ( const H5std_string &  name) const
virtual
Parameters
name- IN: Name of the attribute

Reimplemented from H5::H5Location.

Attribute H5::H5Object::openAttribute ( const unsigned int  idx) const
virtual
Parameters
idx- IN: Index of the attribute, a 0-based, non-negative integer
Returns
Attribute instance
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.

void H5::H5Object::removeAttr ( const char *  name) const
virtual
Parameters
name- IN: Name of the attribute to be removed
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.

void H5::H5Object::removeAttr ( const H5std_string &  name) const
virtual
Parameters
name- IN: Name of the attribute to be removed

Reimplemented from H5::H5Location.

void H5::H5Object::renameAttr ( const char *  oldname,
const char *  newname 
) const
virtual
Parameters
oldname- IN: Name of the attribute to be renamed
newname- IN: New name ame of the attribute
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.

void H5::H5Object::renameAttr ( const H5std_string &  oldname,
const H5std_string &  newname 
) const
virtual
Parameters
oldname- IN: Name of the attribute to be renamed
newname- IN: New name ame of the attribute
Exceptions
H5::AttributeIException

Reimplemented from H5::H5Location.


The documentation for this class was generated from the following file:


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois