Class Group represents an HDF5 group. More...

#include <H5Group.h>

Inheritance diagram for H5::Group:

Public Member Functions
virtual void	close ()
	Closes this group. More...

virtual H5std_string	fromClass () const
	Returns this class name. More...

virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
	Throws H5::GroupIException. More...

virtual hid_t	getLocId () const
	Returns the id of this group. More...

	Group (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a Group object. More...

	Group (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a Group object. More...

	Group ()
	Default constructor: creates a stub Group. More...

	Group (const Group &original)
	Copy constructor: makes a copy of the original Group object. More...

virtual hid_t	getId () const
	Get the id of this group. More...

virtual	~Group ()
	Properly terminates access to this group. More...

	Group (const hid_t group_id)
	Creates a Group object using the id of an existing group. More...

Public Member Functions inherited from H5::H5Object
	H5Object (const H5Object &original)
	Copy constructor: makes a copy of the original H5Object instance. More...

virtual	~H5Object ()
	Noop destructor. More...

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...

H5std_string	getComment (const char *name, size_t bufsize=256) const
	Retrieves comment for the specified object and its comment's length. More...

H5std_string	getComment (const H5std_string &name, size_t bufsize=256) 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...

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...

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)
	Creates an IdComponent object using the id of an existing object. More...

	IdComponent (const IdComponent &original)
	Copy constructor: makes a copy of the original IdComponent object. More...

H5std_string	inMemFunc (const char *func_name) const
	Makes and returns string "<class-name>::<func_name>". More...

virtual	~IdComponent ()
	Noop destructor. More...

Public Member Functions inherited from H5::CommonFG
Group	createGroup (const char *name, size_t size_hint=0) const
	Creates a new group at this location which can be a file or another group. More...

Group	createGroup (const H5std_string &name, size_t size_hint=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...

Group	openGroup (const char *name) const
	Opens an existing group in a location which can be a file or another group. More...

Group	openGroup (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...

DataSet	createDataSet (const char *name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) const
	Creates a new dataset at this location. More...

DataSet	createDataSet (const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) 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...

DataSet	openDataSet (const char *name) const
	Opens an existing dataset at this location. More...

DataSet	openDataSet (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...

H5std_string	getLinkval (const char *link_name, size_t size=0) const
	Returns the name of the object that the symbolic link points to. More...

H5std_string	getLinkval (const H5std_string &link_name, size_t 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...

hsize_t	getNumObjs () const
	Returns the number of objects in this group. More...

H5std_string	getObjnameByIdx (hsize_t idx) const
	Returns the name of an object in this group, given the object's index. More...

ssize_t	getObjnameByIdx (hsize_t idx, char *name, size_t size) const
	Retrieves the name of an object in this group, given the object's index. More...

ssize_t	getObjnameByIdx (hsize_t idx, H5std_string &name, size_t size) 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...

H5G_obj_t	getObjTypeByIdx (hsize_t idx) const
	Returns the type of an object in this group, given the object's index. More...

H5G_obj_t	getObjTypeByIdx (hsize_t idx, char *type_name) const
	This is an overloaded member function, provided for convenience. It differs from the above function because it also provides the returned object type in text (char*) More...

H5G_obj_t	getObjTypeByIdx (hsize_t idx, H5std_string &type_name) const
	This is an overloaded member function, provided for convenience. It differs from the above function because it also provides the returned object type in text (H5std_string&) More...

void	getObjinfo (const char *name, hbool_t follow_link, H5G_stat_t &statbuf) const
	Returns information about an object. More...

void	getObjinfo (const H5std_string &name, hbool_t follow_link, H5G_stat_t &statbuf) 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	getObjinfo (const char *name, H5G_stat_t &statbuf) const
	This is an overloaded member function, provided for convenience. It differs from the above functions in that it doesn't have the paramemter follow_link. More...

void	getObjinfo (const H5std_string &name, H5G_stat_t &statbuf) 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...

int	iterateElems (const char name, int idx, H5G_iterate_t op, void *op_data)
	Iterates a user's function over the entries of a group. More...

int	iterateElems (const H5std_string &name, int idx, H5G_iterate_t op, void op_data)
	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	link (H5L_type_t link_type, const char curr_name, const char new_name) const
	Creates a link of the specified type from new_name to curr_name. More...

void	link (H5L_type_t link_type, const H5std_string &curr_name, const H5std_string &new_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 curr_name and new_name. More...

void	unlink (const char *name) const
	Removes the specified name at this location. More...

void	unlink (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	mount (const char *name, H5File &child, PropList &plist) const
	Mounts the file child onto this group. More...

void	mount (const H5std_string &name, H5File &child, PropList &plist) 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	unmount (const char *name) const
	Unmounts the specified file. More...

void	unmount (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	move (const char src, const char dst) const
	Renames an object at this location. More...

void	move (const H5std_string &src, const H5std_string &dst) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an `H5std_string` for src and dst. More...

DataType	openDataType (const char *name) const
	Opens the named generic datatype at this location. More...

DataType	openDataType (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...

ArrayType	openArrayType (const char *name) const
	Opens the named array datatype at this location. More...

ArrayType	openArrayType (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...

CompType	openCompType (const char *name) const
	Opens the named compound datatype at this location. More...

CompType	openCompType (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...

EnumType	openEnumType (const char *name) const
	Opens the named enumeration datatype at this location. More...

EnumType	openEnumType (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...

IntType	openIntType (const char *name) const
	Opens the named integer datatype at this location. More...

IntType	openIntType (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...

FloatType	openFloatType (const char *name) const
	Opens the named floating-point datatype at this location. More...

FloatType	openFloatType (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...

StrType	openStrType (const char *name) const
	Opens the named string datatype at this location. More...

StrType	openStrType (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...

VarLenType	openVarLenType (const char *name) const
	Opens the named variable length datatype at this location. More...

VarLenType	openVarLenType (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...

	CommonFG ()
	Default constructor. More...

virtual	~CommonFG ()
	Noop destructor. More...

Protected Member Functions
virtual void	p_setId (const hid_t new_id)
	Sets the identifier of this object to a new value. More...

Protected Member Functions inherited from H5::H5Object
	H5Object ()

	H5Object (const hid_t object_id)

Protected Member Functions inherited from H5::H5Location
	H5Location ()

	H5Location (const hid_t loc_id)

	H5Location (const H5Location &original)
	Copy constructor: makes a copy of the original H5Location instance. More...

void	p_reference (void ref, const char name, hid_t space_id, H5R_type_t ref_type) const

hid_t	p_dereference (hid_t loc_id, const void ref, H5R_type_t ref_type, const char from_func)

H5G_obj_t	p_get_obj_type (void *ref, H5R_type_t ref_type) const

H5O_type_t	p_get_ref_obj_type (void *ref, H5R_type_t ref_type) const

virtual	~H5Location ()
	Noop destructor. More...

Protected Member Functions inherited from H5::IdComponent
	IdComponent ()
	Default constructor. More...

H5std_string	p_get_file_name () const

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 Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)

Detailed Description

Class Group represents an HDF5 group.

It inherits many operations from H5Location and CommonFG.

Examples:: h5group.cpp.

Constructor & Destructor Documentation

H5::Group::Group	(	const H5Location &	loc,
		const void *	ref,
		H5R_type_t	ref_type = `H5R_OBJECT`
	)

Given a reference, ref, to an hdf5 group, creates a Group object.

Parameters

loc	- IN: Specifying location referenced object is in
ref	- IN: Reference pointer
ref_type	- IN: Reference type - default to H5R_OBJECT

Exceptions

H5::ReferenceException

Description: obj can be DataSet, Group, or named DataType, that is a datatype that has been named by DataType::commit.

H5::Group::Group	(	const Attribute &	attr,
		const void *	ref,
		H5R_type_t	ref_type = `H5R_OBJECT`
	)

Given a reference, ref, to an hdf5 group, creates a Group object.

Parameters

attr	- IN: Specifying location where the referenced object is in
ref	- IN: Reference pointer
ref_type	- IN: Reference type - default to H5R_OBJECT

Exceptions

H5::ReferenceException

H5::Group::Group ( )

Default constructor: creates a stub Group.

H5::Group::Group ( const Group & original )

Copy constructor: makes a copy of the original Group object.

Parameters

original - IN: Original group to copy

H5::Group::~Group ( )

virtual

Properly terminates access to this group.

H5::Group::Group ( const hid_t existing_id )

Creates a Group object using the id of an existing group.

Parameters

existing_id - IN: Id of an existing group

Member Function Documentation

void H5::Group::close ( )

virtual

Closes this group.

Exceptions

H5::GroupIException

Implements H5::IdComponent.

virtual H5std_string H5::Group::fromClass ( ) const

inlinevirtual

Returns this class name.

Reimplemented from H5::IdComponent.

hid_t H5::Group::getId ( ) const

virtual

Get the id of this group.

Returns: Group identifier

Implements H5::H5Location.

hid_t H5::Group::getLocId ( ) const

virtual

Returns the id of this group.

Returns: Id of this group

Implements H5::CommonFG.

void H5::Group::p_setId ( const hid_t new_id )

protectedvirtual

Sets the identifier of this object to a new value.

Exceptions

H5::IdComponentException when the attempt to close the HDF5 object fails

Implements H5::IdComponent.

void H5::Group::throwException	(	const H5std_string &	func_name,
		const H5std_string &	msg
	)		const

virtual

Throws H5::GroupIException.

Parameters

func_name	- Name of the function where failure occurs
msg	- Message describing the failure

Exceptions

H5::GroupIException

Implements H5::CommonFG.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation