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) 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.
void *	Reference (const char *name, DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
	Creates a reference to an HDF5 object or a dataset region.
void *	Reference (const char *name) const
	This is an overloaded function, provided for your convenience. It differs from the above function in that it only creates a reference to an HDF5 object, not to a dataset region.
void *	Reference (const string &name) const
	This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an std::string for the object's name.
virtual string	fromClass () const
virtual void	throwException (const string func_name, const string msg) const
	Throws H5::GroupIException.
virtual hid_t	getLocId () const
	Returns the id of this group.
	Group ()
	Default constructor: creates a stub Group.
	Group (const Group &original)
	Copy constructor: makes a copy of the original Group object.
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.

---

Constructor & Destructor Documentation

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  group_id  )

Creates a Group object using the id of an existing group. Parameters: group_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 )  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

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::IdComponentException

void * H5::Group::Reference (  const char *  name, DataSpace &  dataspace, H5R_type_t  ref_type = H5R_DATASET_REGION )  const

Creates a reference to an HDF5 object or a dataset region. Parameters: name  - IN: Name of the object to be referenced dataspace  - IN: Dataspace with selection ref_type  - IN: Type of reference; default to H5R_DATASET_REGION Returns: A reference Exceptions: H5::IdComponentException

void * H5::Group::Reference (  const char *  name  )  const

This is an overloaded function, provided for your convenience. It differs from the above function in that it only creates a reference to an HDF5 object, not to a dataset region. Parameters: name  - IN: Name of the object to be referenced Returns: A reference Exceptions: H5::IdComponentException  Description

void * H5::Group::Reference (  const string &  name  )  const

This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an std::string for the object's name. Parameters: name  - IN: Name of the object to be referenced

virtual string H5::Group::fromClass (   )  const [inline, virtual]

Reimplemented from H5::IdComponent.

void H5::Group::throwException (  const string  func_name, const 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 Implements H5::CommonFG.

---