Class Group represents an HDF5 group. More...

#include <H5Group.h>

Inheritance diagram for H5::Group:

Collaboration diagram for H5::Group:

Public Member Functions
virtual void	close ()

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

virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
	For subclasses, H5File and Group, to throw appropriate exception. More...

virtual hid_t	getLocId () const

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

	Group ()

	Group (const Group &original)

virtual hid_t	getId () const
	Returns an identifier. (pure virtual) More...

virtual	~Group ()

	Group (const hid_t group_id)

Public Member Functions inherited from H5::H5Object
Attribute	createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const

Attribute	createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const

Attribute	openAttribute (const char *name) const

Attribute	openAttribute (const H5std_string &name) const

Attribute	openAttribute (const unsigned int idx) const

int	getNumAttrs () const

bool	attrExists (const char *name) const

bool	attrExists (const H5std_string &name) const

void	renameAttr (const char oldname, const char newname) const

void	renameAttr (const H5std_string &oldname, const H5std_string &newname) const

void	removeAttr (const char *name) const

void	removeAttr (const H5std_string &name) 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

virtual	~H5Object ()

Public Member Functions inherited from H5::H5Location
int	getNumAttrs () const

bool	nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

bool	nameExists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	flush (H5F_scope_t scope) const

H5std_string	getFileName () const

void	getObjectInfo (H5O_info_t *oinfo) const

void	getObjectInfo (const char name, H5O_info_t oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getObjectInfo (const H5std_string &name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

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

H5O_type_t	getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const

unsigned	objVersion () const

void	setComment (const char name, const char comment) const

void	setComment (const H5std_string &name, const H5std_string &comment) const

void	setComment (const char *comment) const

void	setComment (const H5std_string &comment) const

ssize_t	getComment (const char name, size_t buf_size, char comment) const

H5std_string	getComment (const char *name, size_t buf_size=0) const

H5std_string	getComment (const H5std_string &name, size_t buf_size=0) const

void	removeComment (const char *name) const

void	removeComment (const H5std_string &name) const

void	reference (void ref, const char name, H5R_type_t ref_type=H5R_OBJECT) const

void	reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const

void	reference (void ref, const char name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

void	reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

void	dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

void	dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

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

hid_t	openObjId (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

hid_t	openObjId (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const char target_name, const char link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &target_name, const H5std_string &link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const char curr_name, const H5Location &new_loc, const char new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &curr_name, const H5Location &new_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const char curr_name, const hid_t same_loc, const char new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &curr_name, const hid_t same_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	unlink (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	unlink (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const char src_name, const H5Location &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const char src_name, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const char src_name, const H5Location &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const char src_name, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5L_info_t	getLinkInfo (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5L_info_t	getLinkInfo (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5std_string	getLinkval (const char *link_name, size_t size=0) const

H5std_string	getLinkval (const H5std_string &link_name, size_t size=0) const

virtual int	iterateAttrs (attr_operator_t user_op, unsigned idx=NULL, void op_data=NULL)

Public Member Functions inherited from H5::IdComponent
void	incRefCount (const hid_t obj_id) const

void	incRefCount () const

void	decRefCount (const hid_t obj_id) const

void	decRefCount () const

int	getCounter (const hid_t obj_id) const

int	getCounter () const

H5I_type_t	getHDFObjType () const

IdComponent &	operator= (const IdComponent &rhs)

void	setId (const hid_t new_id)

H5std_string	inMemFunc (const char *func_name) const

virtual	~IdComponent ()

Public Member Functions inherited from H5::CommonFG
Group	createGroup (const char *name, size_t size_hint=0, const LinkCreatPropList &lc_plist=LinkCreatPropList::DEFAULT) const

Group	createGroup (const H5std_string &name, size_t size_hint=0, const LinkCreatPropList &lc_plist=LinkCreatPropList::DEFAULT) const

Group	openGroup (const char *name) const

Group	openGroup (const H5std_string &name) const

DataSet	createDataSet (const char *name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) const

DataSet	createDataSet (const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) const

DataSet	openDataSet (const char *name) const

DataSet	openDataSet (const H5std_string &name) const

hsize_t	getNumObjs () const

H5std_string	getObjnameByIdx (hsize_t idx) const

ssize_t	getObjnameByIdx (hsize_t idx, char *name, size_t size) const

ssize_t	getObjnameByIdx (hsize_t idx, H5std_string &name, size_t size) const

H5O_type_t	childObjType (const H5std_string &objname) const

H5O_type_t	childObjType (const char *objname) const

H5O_type_t	childObjType (hsize_t index, H5_index_t index_type=H5_INDEX_NAME, H5_iter_order_t order=H5_ITER_INC, const char *objname=".") const

unsigned	childObjVersion (const char *objname) const

unsigned	childObjVersion (const H5std_string &objname) const

H5G_obj_t	getObjTypeByIdx (hsize_t idx) const

H5G_obj_t	getObjTypeByIdx (hsize_t idx, char *type_name) const

H5G_obj_t	getObjTypeByIdx (hsize_t idx, H5std_string &type_name) const

void	getObjinfo (const char *name, hbool_t follow_link, H5G_stat_t &statbuf) const

void	getObjinfo (const H5std_string &name, hbool_t follow_link, H5G_stat_t &statbuf) const

void	getObjinfo (const char *name, H5G_stat_t &statbuf) const

void	getObjinfo (const H5std_string &name, H5G_stat_t &statbuf) const

int	iterateElems (const char name, int idx, H5G_iterate_t op, void *op_data)

int	iterateElems (const H5std_string &name, int idx, H5G_iterate_t op, void op_data)

void	link (H5L_type_t link_type, const char curr_name, const char new_name) const

void	link (H5L_type_t link_type, const H5std_string &curr_name, const H5std_string &new_name) const

void	mount (const char *name, const H5File &child, const PropList &plist) const

void	mount (const H5std_string &name, const H5File &child, const PropList &plist) const

void	unmount (const char *name) const

void	unmount (const H5std_string &name) const

void	move (const char src, const char dst) const

void	move (const H5std_string &src, const H5std_string &dst) const

DataType	openDataType (const char *name) const

DataType	openDataType (const H5std_string &name) const

ArrayType	openArrayType (const char *name) const

ArrayType	openArrayType (const H5std_string &name) const

CompType	openCompType (const char *name) const

CompType	openCompType (const H5std_string &name) const

EnumType	openEnumType (const char *name) const

EnumType	openEnumType (const H5std_string &name) const

IntType	openIntType (const char *name) const

IntType	openIntType (const H5std_string &name) const

FloatType	openFloatType (const char *name) const

FloatType	openFloatType (const H5std_string &name) const

StrType	openStrType (const char *name) const

StrType	openStrType (const H5std_string &name) const

VarLenType	openVarLenType (const char *name) const

VarLenType	openVarLenType (const H5std_string &name) const

	CommonFG ()

virtual	~CommonFG ()

Protected Member Functions
virtual void	p_setId (const hid_t new_id)

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

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

	H5Location (const hid_t loc_id)

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

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

H5std_string	p_get_file_name () const

Private Attributes
hid_t	id

Additional Inherited Members
Static Public Member Functions inherited from H5::H5Location
static void	closeObjId (hid_t obj_id)

Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)

static bool	isValid (hid_t an_id)

Static Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)

Static Protected Attributes inherited from H5::IdComponent
static bool	H5dontAtexit_called

Detailed Description

Class Group represents an HDF5 group.

Definition at line 24 of file H5Group.h.

Constructor & Destructor Documentation

◆ Group() [1/4]

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

◆ Group() [2/4]

H5::Group::Group ( )

◆ Group() [3/4]

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

◆ ~Group()

virtual H5::Group::~Group ( )

virtual

◆ Group() [4/4]

H5::Group::Group ( const hid_t group_id )

Member Function Documentation

◆ close()

virtual void H5::Group::close ( )

virtual

Implements H5::IdComponent.

Reimplemented in H5::H5File.

◆ fromClass()

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

inlinevirtual

Returns this class name.

Reimplemented from H5::IdComponent.

Reimplemented in H5::H5File.

Definition at line 30 of file H5Group.h.

◆ getId()

virtual hid_t H5::Group::getId ( ) const

virtual

Returns an identifier. (pure virtual)

Implements H5::H5Location.

Reimplemented in H5::H5File.

◆ getLocId()

virtual hid_t H5::Group::getLocId ( ) const

virtual

For subclasses, H5File and Group, to return the correct object id, i.e. file or group id.

Implements H5::CommonFG.

Reimplemented in H5::H5File.

◆ p_setId()

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

protectedvirtual

Implements H5::CommonFG.

Reimplemented in H5::H5File.

◆ throwException()

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

virtual

For subclasses, H5File and Group, to throw appropriate exception.

Implements H5::CommonFG.

Reimplemented in H5::H5File.

Field Documentation

◆ id

hid_t H5::Group::id

private

Definition at line 74 of file H5Group.h.

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

win64/HDF5_1.8.21/include/H5Group.h

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Group() [1/4]

◆ Group() [2/4]

◆ Group() [3/4]

◆ ~Group()

◆ Group() [4/4]

Member Function Documentation

◆ close()

◆ fromClass()

◆ getId()

◆ getLocId()

◆ p_setId()

◆ throwException()

Field Documentation

◆ id