Class H5File represents an HDF5 file. More...

#include <H5File.h>

Inheritance diagram for H5::H5File:

Collaboration diagram for H5::H5File:

Public Member Functions
	H5File (const char *name, unsigned int flags, const FileCreatPropList &create_plist=FileCreatPropList::DEFAULT, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)

	H5File (const H5std_string &name, unsigned int flags, const FileCreatPropList &create_plist=FileCreatPropList::DEFAULT, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)

void	openFile (const H5std_string &name, unsigned int flags, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)

void	openFile (const char *name, unsigned int flags, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)

virtual void	close ()

FileAccPropList	getAccessPlist () const

FileCreatPropList	getCreatePlist () const

void	getFileInfo (H5F_info_t &file_info) const

hsize_t	getFileSize () const

hssize_t	getFreeSpace () const

ssize_t	getObjCount (unsigned types=H5F_OBJ_ALL) const

void	getObjIDs (unsigned types, size_t max_objs, hid_t *oid_list) const

void	getVFDHandle (void **file_handle) const

void	getVFDHandle (const FileAccPropList &fapl, void **file_handle) const

void	reOpen ()

void	reopen ()

virtual hid_t	getLocId () const

	H5File (hid_t existing_id)

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...

	H5File ()

	H5File (const H5File &original)

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

virtual	~H5File ()

Public Member Functions inherited from H5::Group
	Group (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

	Group ()

	Group (const Group &original)

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

Static Public Member Functions
static bool	isHdf5 (const char *name)

static bool	isHdf5 (const H5std_string &name)

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)

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 Member Functions
void	p_get_file (const char *name, unsigned int flags, const FileCreatPropList &create_plist, const FileAccPropList &access_plist)

Private Attributes
hid_t	id

Additional Inherited Members
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 H5File represents an HDF5 file.

Modification: May 5, 2017: In the class rearrangement of 1.8.10, H5File should have been moved to inherit from Group instead, because HDF5 file is a root group. It is now done in 1.10 (Mar 30) and 1.8.19 releases. -BMR

Definition at line 30 of file H5File.h.

Constructor & Destructor Documentation

◆ H5File() [1/5]

H5::H5File::H5File	(	const char *	name,
		unsigned int	flags,
		const FileCreatPropList &	create_plist = `FileCreatPropList::DEFAULT`,
		const FileAccPropList &	access_plist = `FileAccPropList::DEFAULT`
	)

◆ H5File() [2/5]

H5::H5File::H5File	(	const H5std_string &	name,
		unsigned int	flags,
		const FileCreatPropList &	create_plist = `FileCreatPropList::DEFAULT`,
		const FileAccPropList &	access_plist = `FileAccPropList::DEFAULT`
	)

◆ H5File() [3/5]

H5::H5File::H5File ( hid_t existing_id )

◆ H5File() [4/5]

H5::H5File::H5File ( )

◆ H5File() [5/5]

H5::H5File::H5File ( const H5File & original )

◆ ~H5File()

virtual H5::H5File::~H5File ( )

virtual

Member Function Documentation

◆ close()

virtual void H5::H5File::close ( )

virtual

Reimplemented from H5::Group.

◆ fromClass()

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

inlinevirtual

Returns this class name.

Reimplemented from H5::Group.

Definition at line 97 of file H5File.h.

◆ getAccessPlist()

FileAccPropList H5::H5File::getAccessPlist ( ) const

◆ getCreatePlist()

FileCreatPropList H5::H5File::getCreatePlist ( ) const

◆ getFileInfo()

void H5::H5File::getFileInfo ( H5F_info_t & file_info ) const

◆ getFileSize()

hsize_t H5::H5File::getFileSize ( ) const

◆ getFreeSpace()

hssize_t H5::H5File::getFreeSpace ( ) const

◆ getId()

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

virtual

Returns an identifier. (pure virtual)

Reimplemented from H5::Group.

◆ getLocId()

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

virtual

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

Reimplemented from H5::Group.

◆ getObjCount()

ssize_t H5::H5File::getObjCount ( unsigned types = H5F_OBJ_ALL ) const

◆ getObjIDs()

void H5::H5File::getObjIDs	(	unsigned	types,
		size_t	max_objs,
		hid_t *	oid_list
	)		const

◆ getVFDHandle() [1/2]

void H5::H5File::getVFDHandle ( void ** file_handle ) const

◆ getVFDHandle() [2/2]

void H5::H5File::getVFDHandle	(	const FileAccPropList &	fapl,
		void **	file_handle
	)		const

◆ isHdf5() [1/2]

static bool H5::H5File::isHdf5 ( const char * name )

static

◆ isHdf5() [2/2]

static bool H5::H5File::isHdf5 ( const H5std_string & name )

static

◆ openFile() [1/2]

void H5::H5File::openFile	(	const H5std_string &	name,
		unsigned int	flags,
		const FileAccPropList &	access_plist = `FileAccPropList::DEFAULT`
	)

◆ openFile() [2/2]

void H5::H5File::openFile	(	const char *	name,
		unsigned int	flags,
		const FileAccPropList &	access_plist = `FileAccPropList::DEFAULT`
	)

◆ p_get_file()

void H5::H5File::p_get_file	(	const char *	name,
		unsigned int	flags,
		const FileCreatPropList &	create_plist,
		const FileAccPropList &	access_plist
	)

private

◆ p_setId()

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

protectedvirtual

Reimplemented from H5::Group.

◆ reOpen()

void H5::H5File::reOpen ( )

◆ reopen()

void H5::H5File::reopen ( )

◆ throwException()

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

virtual

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

Reimplemented from H5::Group.

Field Documentation

◆ id

hid_t H5::H5File::id

private

Definition at line 121 of file H5File.h.

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

win64/HDF5_1.8.21/include/H5File.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ H5File() [1/5]

◆ H5File() [2/5]

◆ H5File() [3/5]

◆ H5File() [4/5]

◆ H5File() [5/5]

◆ ~H5File()

Member Function Documentation

◆ close()

◆ fromClass()

◆ getAccessPlist()

◆ getCreatePlist()

◆ getFileInfo()

◆ getFileSize()

◆ getFreeSpace()

◆ getId()

◆ getLocId()

◆ getObjCount()

◆ getObjIDs()

◆ getVFDHandle() [1/2]

◆ getVFDHandle() [2/2]

◆ isHdf5() [1/2]

◆ isHdf5() [2/2]

◆ openFile() [1/2]

◆ openFile() [2/2]

◆ p_get_file()

◆ p_setId()

◆ reOpen()

◆ reopen()

◆ throwException()

Field Documentation

◆ id