HDF5 C++ API Reference Manual

 

 

H5::Group Class Reference

#include <H5Group.h>

Inheritance diagram for H5::Group:

List of all members.

Public Member Functions
virtual void	close ()
	Closes this group.
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.
DataSpace	getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
	Retrieves a dataspace with the region pointed to selected.
virtual H5std_string	fromClass () const
	Returns this class name.
virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
	Throws H5::GroupIException.
virtual hid_t	getLocId () const
	Returns the id of this group.
	Group (H5Object &obj, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a Group object.
	Group (H5File &h5file, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a Group object.
	Group (Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a Group object.
	Group ()
	Default constructor: creates a stub Group.
	Group (const Group &original)
	Copy constructor: makes a copy of the original Group object.
virtual hid_t	getId () const
virtual	~Group ()
	Properly terminates access to this group.
	Group (const hid_t group_id)
	Creates a Group object using the id of an existing group.
Protected Member Functions
virtual void	p_setId (const hid_t new_id)
	Sets the identifier of this object to a new value.

---

Detailed Description

Examples:

h5group.cpp.

---

Constructor & Destructor Documentation

H5::Group::Group	(	H5Object &	obj,
		const void *	ref,
		H5R_type_t	ref_type = H5R_OBJECT
	)

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

Parameters:

	obj	- 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	(	H5File &	h5file,
		const void *	ref,
		H5R_type_t	ref_type = H5R_OBJECT
	)

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

Parameters:

	h5file	- IN: Location referenced object is in
	ref	- IN: Reference pointer
	ref_type	- IN: Reference type - default to H5R_OBJECT

Exceptions:

H5::ReferenceException

H5::Group::Group	(	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

H5G_obj_t H5::Group::getObjType	(	void *	ref,
		H5R_type_t	ref_type = H5R_OBJECT
	)			const

Retrieves the type of object that an object reference points to.

Parameters:

	ref	- IN: Reference to query
	ref_type	- IN: Type of reference to query, valid values are: H5R_OBJECT - Reference is an object reference. H5R_DATASET_REGION - Reference is a dataset region reference.

Returns:

An object type, which can be one of the following:

• H5G_LINK (0) - Object is a symbolic link.
• H5G_GROUP (1) - Object is a group.
• H5G_DATASET (2) - Object is a dataset.
• H5G_TYPE (3) - Object is a named datatype

Exceptions:

H5::GroupIException

DataSpace H5::Group::getRegion	(	void *	ref,
		H5R_type_t	ref_type = H5R_DATASET_REGION
	)			const

Retrieves a dataspace with the region pointed to selected.

Parameters:

	ref	- IN: Reference to get region of
	ref_type	- IN: Type of reference to get region of - default

Returns:

DataSpace instance

Exceptions:

H5::GroupIException

virtual H5std_string H5::Group::fromClass

(

)

const [inline, virtual]

Returns this class name.

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.

hid_t H5::Group::getLocId

(

)

const [virtual]

Returns the id of this group.

Returns:

Id of this group

hid_t H5::Group::getId

(

)

const [virtual]

Implements H5::IdComponent.

void H5::Group::p_setId

(

const hid_t

new_id

)

[protected, virtual]

Sets the identifier of this object to a new value.

Exceptions:

H5::IdComponentException

when the attempt to close the HDF5 object fails

---