HDF5 C++ API Reference Manual

 

 

 

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members | Examples

H5::Group Class Reference

#include <H5Group.h>

Inheritance diagram for H5::Group:

H5::H5Object H5::CommonFG H5::IdComponent 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.
void * Reference (const char *name, DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
 Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!
void * Reference (const char *name) const
 Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!
void * Reference (const H5std_string &name) const
 Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!
virtual H5std_string fromClass () const
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 (IdComponent &obj, void *ref)
 Given a reference to some object, returns that 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 (  IdComponent &  obj,
void *  ref
) 
 

Given a reference to some object, returns that group.

Parameters:
obj - IN: Location reference object is in
ref - IN: Reference pointer
Description
obj can be DataSet, Group, H5File, or named DataType, that is a datatype that has been named by DataType::commit.

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 = 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 Object is a symbolic link. H5G_GROUP Object is a group. H5G_DATASET Object is a dataset. H5G_TYPE 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 

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

Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!

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

Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!

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

Important!!! - This functions may not work correctly, it will be removed in the near future. Please use similar Group::reference instead!

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

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

Generated on Tue Aug 14 13:57:00 2007 by  doxygen 1.3.9.1