H5::H5Location Class Reference

H5Location is an abstract base class, added in version 1.8.12. More...

#include <H5Location.h>

Inheritance diagram for H5::H5Location:

Public Member Functions
bool	nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Checks if a link of a given name exists in a location. More...
bool	nameExists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Checks if a link of a given name exists in a location. More...
bool	exists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Deprecated in favor of nameExists. More...
bool	exists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Deprecated in favor of nameExists. More...
void	flush (H5F_scope_t scope) const
	Flushes all buffers associated with a location to disk. More...
H5std_string	getFileName () const
	Gets the name of the file, in which an HDF5 object at this location belongs. More...
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. More...
H5O_type_t	getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const
	Retrieves the type of object that an object reference points to. More...
void	setComment (const char *name, const char *comment) const
	Sets or resets the comment for an object specified by its name. More...
void	setComment (const H5std_string &name, const H5std_string &comment) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name and comment. More...
void	setComment (const char *comment) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it doesn't take an object name. More...
void	setComment (const H5std_string &comment) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for comment. More...
ssize_t	getComment (const char *name, size_t buf_size, char *comment) const
	Retrieves the comment for this location, returning its length. More...
H5std_string	getComment (const char *name, size_t buf_size=0) const
	Returns the comment as string for this location, returning its length. More...
H5std_string	getComment (const H5std_string &name, size_t buf_size=0) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
void	removeComment (const char *name) const
	Removes the comment from an object specified by its name. More...
void	removeComment (const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
void	reference (void *ref, const char *name, H5R_type_t ref_type=H5R_OBJECT) const
	This is an overloaded function, provided for your convenience. It differs from the above function in that it does not take a DataSpace object and the reference type must be specified. More...
void	reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const
	This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an H5std_string for the object's name. More...
void	reference (void *ref, const char *name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
	Creates a reference to an HDF5 object or a dataset region. More...
void	reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...
void	dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT, const PropList &plist=PropList::DEFAULT)
	Dereferences a reference into an HDF5 object, given an HDF5 object. More...
DataSpace	getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
Group	createGroup (const char *name, const LinkCreatPropList &lcpl) const
Group	createGroup (const H5std_string &name, const LinkCreatPropList &lcpl) const
Group	createGroup (const char *name, size_t size_hint=0) const
Group	createGroup (const H5std_string &name, size_t size_hint=0) 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 DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const
DataSet	createDataSet (const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const
DataSet	openDataSet (const char *name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const
DataSet	openDataSet (const H5std_string &name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const
H5L_info2_t	getLinkInfo (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
H5L_info2_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
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
void	getObjinfo (H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC) const
void	getObjinfo (const char *name, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getObjinfo (const H5std_string &name, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getObjinfo (const char *grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getObjinfo (const H5std_string &grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getNativeObjinfo (H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR) const
void	getNativeObjinfo (const char *name, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getNativeObjinfo (const H5std_string &name, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getNativeObjinfo (const char *grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	getNativeObjinfo (const H5std_string &grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) 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 (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 Group &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 Group &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	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	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	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	copyLink (const char *src_name, const Group &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	copyLink (const H5std_string &src_name, const Group &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 Group &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void	moveLink (const H5std_string &src_name, const Group &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
void	move (const char *src, const char *dst) const
void	move (const H5std_string &src, const H5std_string &dst) const
virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
	For subclasses, H5File and Group, to throw appropriate exception. More...
	H5Location ()
Public Member Functions inherited from H5::IdComponent
void	incRefCount (const hid_t obj_id) const
	Increment reference counter for a given id. More...
void	incRefCount () const
	Increment reference counter for the id of this object. More...
void	decRefCount (const hid_t obj_id) const
	Decrement reference counter for a given id. More...
void	decRefCount () const
	Decrement reference counter for the id of this object. More...
int	getCounter (const hid_t obj_id) const
	Returns the reference counter for a given id. More...
int	getCounter () const
	Returns the reference counter for the id of this object. More...
H5I_type_t	getHDFObjType () const
	Returns the type of the object. It is an overloaded function of the above function. More...
IdComponent &	operator= (const IdComponent &rhs)
	Assignment operator. More...
void	setId (const hid_t new_id)
	Sets the identifier of this object to a new value. More...
virtual	~IdComponent ()
	Noop destructor. More...

Protected Member Functions
virtual	~H5Location ()

Additional Inherited Members
Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)
	Given an id, returns the type of the object. More...
static hsize_t	getNumMembers (H5I_type_t type)
	Returns the number of members of the given type. More...
static bool	isValid (hid_t an_id)
	Checks if the given ID is valid. More...
static bool	typeExists (H5I_type_t type)
	Queries if a given type is currently registered with the library. More...

Detailed Description

It provides a collection of wrappers for the C functions that take a location identifier to specify the HDF5 object. The location identifier can be either file, group, dataset, attribute, or named datatype. Wrappers for H5A functions stay in H5Object.

Constructor & Destructor Documentation

H5::H5Location::H5Location

(

)

virtual H5::H5Location::~H5Location ( )

protectedvirtual

Member Function Documentation

H5O_type_t H5::H5Location::childObjType

(

const H5std_string &

objname

)

const

H5O_type_t H5::H5Location::childObjType

(

const char *

objname

)

const

H5O_type_t H5::H5Location::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 H5::H5Location::childObjVersion

(

const char *

objname

)

const

unsigned H5::H5Location::childObjVersion

(

const H5std_string &

objname

)

const

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

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

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

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

DataSet H5::H5Location::createDataSet	(	const char *	name,
		const DataType &	data_type,
		const DataSpace &	data_space,
		const DSetCreatPropList &	create_plist = DSetCreatPropList::DEFAULT,
		const DSetAccPropList &	dapl = DSetAccPropList::DEFAULT,
		const LinkCreatPropList &	lcpl = LinkCreatPropList::DEFAULT
	)		const

Examples:

compound.cpp, create.cpp, extend_ds.cpp, h5group.cpp, and writedata.cpp.

DataSet H5::H5Location::createDataSet	(	const H5std_string &	name,
		const DataType &	data_type,
		const DataSpace &	data_space,
		const DSetCreatPropList &	create_plist = DSetCreatPropList::DEFAULT,
		const DSetAccPropList &	dapl = DSetAccPropList::DEFAULT,
		const LinkCreatPropList &	lcpl = LinkCreatPropList::DEFAULT
	)		const

Group H5::H5Location::createGroup	(	const char *	name,
		const LinkCreatPropList &	lcpl
	)		const

Examples:

h5group.cpp.

Group H5::H5Location::createGroup	(	const H5std_string &	name,
		const LinkCreatPropList &	lcpl
	)		const

Group H5::H5Location::createGroup	(	const char *	name,
		size_t	size_hint = 0
	)		const

Group H5::H5Location::createGroup	(	const H5std_string &	name,
		size_t	size_hint = 0
	)		const

void H5::H5Location::dereference	(	const H5Location &	loc,
		const void *	ref,
		H5R_type_t	ref_type = H5R_OBJECT,
		const PropList &	plist = PropList::DEFAULT
	)

Parameters

loc	- IN: Location of the referenced object
ref	- IN: Reference pointer
ref_type	- IN: Reference type
plist	- IN: Property list - default to PropList::DEFAULT

Exceptions

H5::ReferenceException

bool H5::H5Location::exists	(	const char *	name,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

Parameters

name	- IN: Searched name
lapl	- IN: Link access property list

Exceptions

H5::LocationException

References nameExists().

bool H5::H5Location::exists	(	const H5std_string &	name,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

Parameters

name	- IN: Searched name
lapl	- IN: Link access property list

Exceptions

H5::LocationException

References nameExists().

void H5::H5Location::flush

(

H5F_scope_t

scope

)

const

Parameters

scope

- IN: Specifies the scope of the flushing action, which can be either of these values: H5F_SCOPE_GLOBAL - Flushes the entire virtual file H5F_SCOPE_LOCAL - Flushes only the specified file

Exceptions

H5::LocationException

Description

This location is used to identify the file to be flushed.

ssize_t H5::H5Location::getComment	(	const char *	name,
		size_t	buf_size,
		char *	comment
	)		const

Parameters

name	- IN: Name of the object
buf_size	- IN: Length of the comment to retrieve
comment	- OUT: Retrieved comment

Returns

Actual length of the comment

Exceptions

H5::LocationException

Description

This function retrieves buf_size characters of the comment including the null terminator. Thus, if the actual length of the comment is more than buf_size-1, the retrieved comment will be truncated to accommodate the null terminator.

Referenced by getComment().

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

Parameters

name	- IN: Name of the object
buf_size	- IN: Length of the comment to retrieve, default to 0

Returns

Comment string

Exceptions

H5::LocationException

References getComment().

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

References getComment().

H5std_string H5::H5Location::getFileName

(

)

const

Returns

File name

Exceptions

H5::LocationException

References H5::Exception::getDetailMsg().

H5L_info2_t H5::H5Location::getLinkInfo	(	const char *	link_name,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

H5L_info2_t H5::H5Location::getLinkInfo	(	const H5std_string &	link_name,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

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

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

void H5::H5Location::getNativeObjinfo	(	H5O_native_info_t &	objinfo,
		unsigned	fields = H5O_NATIVE_INFO_HDR
	)		const

void H5::H5Location::getNativeObjinfo	(	const char *	name,
		H5O_native_info_t &	objinfo,
		unsigned	fields = H5O_NATIVE_INFO_HDR,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getNativeObjinfo	(	const H5std_string &	name,
		H5O_native_info_t &	objinfo,
		unsigned	fields = H5O_NATIVE_INFO_HDR,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getNativeObjinfo	(	const char *	grp_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	idx,
		H5O_native_info_t &	objinfo,
		unsigned	fields = H5O_NATIVE_INFO_HDR,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getNativeObjinfo	(	const H5std_string &	grp_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	idx,
		H5O_native_info_t &	objinfo,
		unsigned	fields = H5O_NATIVE_INFO_HDR,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

hsize_t H5::H5Location::getNumObjs

(

)

const

void H5::H5Location::getObjinfo	(	H5O_info2_t &	objinfo,
		unsigned	fields = H5O_INFO_BASIC
	)		const

void H5::H5Location::getObjinfo	(	const char *	name,
		H5O_info2_t &	objinfo,
		unsigned	fields = H5O_INFO_BASIC,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getObjinfo	(	const H5std_string &	name,
		H5O_info2_t &	objinfo,
		unsigned	fields = H5O_INFO_BASIC,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getObjinfo	(	const char *	grp_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	idx,
		H5O_info2_t &	objinfo,
		unsigned	fields = H5O_INFO_BASIC,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

void H5::H5Location::getObjinfo	(	const H5std_string &	grp_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	idx,
		H5O_info2_t &	objinfo,
		unsigned	fields = H5O_INFO_BASIC,
		const LinkAccPropList &	lapl = LinkAccPropList::DEFAULT
	)		const

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

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

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

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

H5std_string H5::H5Location::getObjnameByIdx

(

hsize_t

idx

)

const

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

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

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

Parameters

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.
ref	- IN: Reference to query

Returns

An object type, which can be one of the following:

• H5G_UNKNOWN - A failure occurs. (-1)
• H5G_GROUP - Object is a group.
• H5G_DATASET - Object is a dataset.
• H5G_TYPE Object - is a named datatype
• H5G_LINK - Object is a symbolic link.
• H5G_UDLINK - Object is a user-defined link.

Exceptions

H5::ReferenceException

References H5::Exception::getDetailMsg().

H5G_obj_t H5::H5Location::getObjTypeByIdx

(

hsize_t

idx

)

const

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

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

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

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:

• H5O_TYPE_UNKNOWN - Unknown object type (-1)
• H5O_TYPE_GROUP - Object is a group
• H5O_TYPE_DATASET - Object is a dataset
• H5O_TYPE_NAMED_DATATYPE - Object is a named datatype
• H5O_TYPE_NTYPES - Number of different object types

Exceptions

H5::ReferenceException

References H5::Exception::getDetailMsg().

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

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

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

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

Examples:

h5group.cpp.

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

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

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

void H5::H5Location::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 H5::H5Location::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 H5::H5Location::link	(	H5L_type_t	link_type,
		const char *	curr_name,
		const char *	new_name
	)		const

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

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

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

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

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

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

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

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

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

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

Parameters

name	- IN: Searched name
lapl	- IN: Link access property list

Exceptions

H5::LocationException

References H5::PropList::getId().

Referenced by exists(), and nameExists().

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

Parameters

name	- IN: Searched name
lapl	- IN: Link access property list

Exceptions

H5::LocationException

References nameExists().

DataSet H5::H5Location::openDataSet	(	const char *	name,
		const DSetAccPropList &	dapl = DSetAccPropList::DEFAULT
	)		const

Examples:

chunks.cpp, compound.cpp, h5group.cpp, readdata.cpp, and writedata.cpp.

DataSet H5::H5Location::openDataSet	(	const H5std_string &	name,
		const DSetAccPropList &	dapl = DSetAccPropList::DEFAULT
	)		const

Group H5::H5Location::openGroup

(

const char *

name

)

const

Examples:

h5group.cpp.

Group H5::H5Location::openGroup

(

const H5std_string &

name

)

const

void H5::H5Location::reference	(	void *	ref,
		const char *	name,
		H5R_type_t	ref_type = H5R_OBJECT
	)		const

Parameters

ref	- IN: Reference pointer
name	- IN: Name of the object to be referenced
ref_type	- IN: Type of reference to query, valid values are: H5R_OBJECT - Reference is an object reference (default) H5R_DATASET_REGION - Reference is a dataset region

Exceptions

H5::ReferenceException

Note

This method is more suitable for an object reference.

References H5::Exception::getDetailMsg().

Referenced by reference().

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

Parameters

ref	- IN: Reference pointer
name	- IN: Name of the object to be referenced - H5std_string
ref_type	- IN: Type of reference to query, valid values are: H5R_OBJECT - Reference is an object reference (default) H5R_DATASET_REGION - Reference is a dataset region

Note

This method is more suitable for an object reference.

References reference().

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

Parameters

ref	- IN: Reference pointer
name	- IN: Name of the object to be referenced
dataspace	- IN: Dataspace with selection
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. (default)

Exceptions

H5::ReferenceException

Note

This method is more suitable for a dataset region reference.

References H5::Exception::getDetailMsg(), and H5::DataSpace::getId().

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

Parameters

ref	- IN: Reference pointer
name	- IN: Name of the object to be referenced
dataspace	- IN: Dataspace with selection
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. (default)

Exceptions

H5::ReferenceException

Note

This method is more suitable for a dataset region reference.

References H5::Exception::getDetailMsg(), and H5::DataSpace::getId().

void H5::H5Location::removeComment

(

const char *

name

)

const

Parameters

name	- IN: Name of the object

Exceptions

H5::LocationException

Referenced by removeComment().

void H5::H5Location::removeComment

(

const H5std_string &

name

)

const

References removeComment().

void H5::H5Location::setComment	(	const char *	name,
		const char *	comment
	)		const

Parameters

name	- IN: Name of the object
comment	- IN: New comment

Exceptions

H5::LocationException

Description

If comment is an empty string or a null pointer, the comment message is removed from the object. Comments should be relatively short, null-terminated, ASCII strings. They can be attached to any object that has an object header, e.g., data sets, groups, named data types, and data spaces, but not symbolic links.

Referenced by setComment().

void H5::H5Location::setComment	(	const H5std_string &	name,
		const H5std_string &	comment
	)		const

References setComment().

void H5::H5Location::setComment

(

const char *

comment

)

const

void H5::H5Location::setComment

(

const H5std_string &

comment

)

const

References setComment().

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

virtual

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

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

Examples:

h5group.cpp.

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

void H5::H5Location::unmount

(

const char *

name

)

const

void H5::H5Location::unmount

(

const H5std_string &

name

)

const

---

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

• H5Location.h
• H5Location.cpp