H5::CommonFG Class Reference

CommonFG is an abstract base class of H5File and H5Group. More...

#include <H5CommonFG.h>

Inheritance diagram for H5::CommonFG:

Collaboration diagram for H5::CommonFG:

Public Member Functions
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
virtual hid_t	getLocId () const =0
virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const =0
	For subclasses, H5File and Group, to throw appropriate exception. More...
	CommonFG ()
virtual	~CommonFG ()

Protected Member Functions
virtual void	p_setId (const hid_t new_id)=0

Detailed Description

CommonFG is an abstract base class of H5File and H5Group.

It provides common operations of H5File and H5Group.

Definition at line 29 of file H5CommonFG.h.

Constructor & Destructor Documentation

CommonFG()

H5::CommonFG::CommonFG

(

)

~CommonFG()

virtual H5::CommonFG::~CommonFG ( )

virtual

Member Function Documentation

childObjType() [1/3]

H5O_type_t H5::CommonFG::childObjType

(

const H5std_string &

objname

)

const

childObjType() [2/3]

H5O_type_t H5::CommonFG::childObjType

(

const char *

objname

)

const

childObjType() [3/3]

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

childObjVersion() [1/2]

unsigned H5::CommonFG::childObjVersion

(

const char *

objname

)

const

childObjVersion() [2/2]

unsigned H5::CommonFG::childObjVersion

(

const H5std_string &

objname

)

const

createDataSet() [1/2]

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

createDataSet() [2/2]

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

createGroup() [1/2]

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

createGroup() [2/2]

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

getLocId()

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

pure virtual

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

Implemented in H5::H5File, and H5::Group.

getNumObjs()

hsize_t H5::CommonFG::getNumObjs

(

)

const

getObjinfo() [1/4]

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

getObjinfo() [2/4]

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

getObjinfo() [3/4]

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

getObjinfo() [4/4]

void H5::CommonFG::getObjinfo	(	const H5std_string &	name,
		H5G_stat_t &	statbuf
	)		const

getObjnameByIdx() [1/3]

H5std_string H5::CommonFG::getObjnameByIdx

(

hsize_t

idx

)

const

getObjnameByIdx() [2/3]

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

getObjnameByIdx() [3/3]

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

getObjTypeByIdx() [1/3]

H5G_obj_t H5::CommonFG::getObjTypeByIdx

(

hsize_t

idx

)

const

getObjTypeByIdx() [2/3]

H5G_obj_t H5::CommonFG::getObjTypeByIdx	(	hsize_t	idx,
		char *	type_name
	)		const

getObjTypeByIdx() [3/3]

H5G_obj_t H5::CommonFG::getObjTypeByIdx	(	hsize_t	idx,
		H5std_string &	type_name
	)		const

iterateElems() [1/2]

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

iterateElems() [2/2]

int H5::CommonFG::iterateElems	(	const H5std_string &	name,
		int *	idx,
		H5G_iterate_t	op,
		void *	op_data
	)

link() [1/2]

void H5::CommonFG::link	(	H5L_type_t	link_type,
		const char *	curr_name,
		const char *	new_name
	)		const

link() [2/2]

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

mount() [1/2]

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

mount() [2/2]

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

move() [1/2]

void H5::CommonFG::move	(	const char *	src,
		const char *	dst
	)		const

move() [2/2]

void H5::CommonFG::move	(	const H5std_string &	src,
		const H5std_string &	dst
	)		const

openArrayType() [1/2]

ArrayType H5::CommonFG::openArrayType

(

const char *

name

)

const

openArrayType() [2/2]

ArrayType H5::CommonFG::openArrayType

(

const H5std_string &

name

)

const

openCompType() [1/2]

CompType H5::CommonFG::openCompType

(

const char *

name

)

const

openCompType() [2/2]

CompType H5::CommonFG::openCompType

(

const H5std_string &

name

)

const

openDataSet() [1/2]

DataSet H5::CommonFG::openDataSet

(

const char *

name

)

const

openDataSet() [2/2]

DataSet H5::CommonFG::openDataSet

(

const H5std_string &

name

)

const

openDataType() [1/2]

DataType H5::CommonFG::openDataType

(

const char *

name

)

const

openDataType() [2/2]

DataType H5::CommonFG::openDataType

(

const H5std_string &

name

)

const

openEnumType() [1/2]

EnumType H5::CommonFG::openEnumType

(

const char *

name

)

const

openEnumType() [2/2]

EnumType H5::CommonFG::openEnumType

(

const H5std_string &

name

)

const

openFloatType() [1/2]

FloatType H5::CommonFG::openFloatType

(

const char *

name

)

const

openFloatType() [2/2]

FloatType H5::CommonFG::openFloatType

(

const H5std_string &

name

)

const

openGroup() [1/2]

Group H5::CommonFG::openGroup

(

const char *

name

)

const

openGroup() [2/2]

Group H5::CommonFG::openGroup

(

const H5std_string &

name

)

const

openIntType() [1/2]

IntType H5::CommonFG::openIntType

(

const char *

name

)

const

openIntType() [2/2]

IntType H5::CommonFG::openIntType

(

const H5std_string &

name

)

const

openStrType() [1/2]

StrType H5::CommonFG::openStrType

(

const char *

name

)

const

openStrType() [2/2]

StrType H5::CommonFG::openStrType

(

const H5std_string &

name

)

const

openVarLenType() [1/2]

VarLenType H5::CommonFG::openVarLenType

(

const char *

name

)

const

openVarLenType() [2/2]

VarLenType H5::CommonFG::openVarLenType

(

const H5std_string &

name

)

const

p_setId()

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

protectedpure virtual

Implemented in H5::H5File, and H5::Group.

throwException()

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

pure virtual

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

Implemented in H5::H5File, and H5::Group.

unmount() [1/2]

void H5::CommonFG::unmount

(

const char *

name

)

const

unmount() [2/2]

void H5::CommonFG::unmount

(

const H5std_string &

name

)

const

---

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

• win64/HDF5_1.8.21/include/H5CommonFG.h