HDF5 C++ API: H5::H5Location Class Reference

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

References H5::PropList::getId(), and throwException().

Referenced by exists().

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

References exists().

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::Exception

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

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

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

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

Parameters

name	- IN: Symbolic link to the object
size	- IN: Maximum number of characters of value to be returned

Returns: Name of the object

Exceptions

H5::FileIException or H5::GroupIException

References throwException().

Referenced by getLinkval().

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

References getLinkval().

int H5::H5Location::getNumAttrs ( ) const

Returns: Number of attributes

Exceptions

H5::AttributeIException

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

Parameters

name	- IN: Name of the object
follow_link	- IN: Link flag
statbuf	- OUT: Buffer to return information about the object

Exceptions

H5::FileIException or H5::GroupIException

Description: For more information, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetObjinfo

References throwException().

Referenced by getObjinfo().

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

References getObjinfo().

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

References throwException().

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

References getObjinfo().

H5std_string H5::H5Location::getObjnameByIdx ( hsize_t idx ) const

Parameters

idx	- IN: Transient index of the object

Returns: Object name

Exceptions

H5::FileIException or H5::GroupIException

Description: The value of idx can be any nonnegative number less than the total number of objects in the group, which is returned by the function H5Location::getNumObjs. Note that this is a transient index; thus, an object may have a different index each time the group is opened.

References throwException().

Referenced by getObjnameByIdx().

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

Parameters

idx	- IN: Transient index of the object
name	- IN/OUT: Retrieved name of the object
size	- IN: Length to retrieve

Returns: Actual size of the object name or 0, if object has no name

Exceptions

H5::FileIException or H5::GroupIException

Description: The value of idx can be any nonnegative number less than the total number of objects in the group, which is returned by the function H5Location::getNumObjs. Note that this is a transient index; thus, an object may have a different index each time the group is opened.

References throwException().

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

References getObjnameByIdx(), and throwException().

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

H5G_obj_t H5::H5Location::getObjTypeByIdx ( hsize_t idx ) const

Parameters

idx	- IN: Transient index of the object

Returns: Object type

Exceptions

H5::FileIException or H5::GroupIException

References throwException().

Referenced by getObjTypeByIdx().

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

Parameters

idx	- IN: Transient index of the object
type_name	- OUT: Object type in text

Returns: Object type

Exceptions

H5::FileIException or H5::GroupIException

References getObjTypeByIdx().

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

Parameters

idx	- IN: Transient index of the object
type_name	- OUT: Object type in text

Returns: Object type

Exceptions

H5::FileIException or H5::GroupIException

References throwException().

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

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

Parameters

ref	- IN: Reference to get region of
ref_type	- IN: Type of reference to get region of - default

Returns: DataSpace object

Exceptions

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

Parameters

name	- IN : Name of group to iterate over
idx	- IN/OUT: Starting (IN) and ending (OUT) entry indices
op	- IN : User's function to operate on each entry
op_data	- IN/OUT: Data associated with the operation

Returns: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero.

Exceptions

H5::FileIException or H5::GroupIException

References throwException().

Referenced by iterateElems().

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

References iterateElems().

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

Parameters

link_type	- IN: Link type; possible values are `H5G_LINK_HARD` `H5G_LINK_SOFT`
curr_name	- IN: Name of the existing object if link is a hard link; can be anything for the soft link
new_name	- IN: New name for the object

Exceptions

H5::FileIException or H5::GroupIException

Description: Note that both names are interpreted relative to the specified location. For information on creating hard link and soft link, please refer to the C layer Reference Manual at: http://hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateHard and http://hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateSoft

Examples:: h5group.cpp.

References throwException().

Referenced by link().

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

References link().

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

Parameters

name	- IN: Name of the group
child	- IN: File to mount
plist	- IN: Property list to use

Exceptions

H5::FileIException or H5::GroupIException

References H5::H5File::getId(), H5::PropList::getId(), and throwException().

Referenced by mount().

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

References mount().

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

Parameters

src	- IN: Object's original name
dst	- IN: Object's new name

Exceptions

H5::FileIException or H5::GroupIException

Note: Exercise care in moving groups as it is possible to render data in a file inaccessible with H5Location::move. Please refer to the Group Interface in the HDF5 User's Guide for details at: https://www.hdfgroup.org/HDF5/doc/UG/HDF5_Users_Guide-Responsive%20HTML5/index.html#t=HDF5_Users_Guide%2FGroups%2FHDF5_Groups.htm

References throwException().

Referenced by move().

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

References move().

DataSet H5::H5Location::openDataSet ( const char * name ) const

Parameters

name	- IN: Name of the dataset to open

Returns: DataSet instance

Exceptions

H5::FileIException or H5::GroupIException

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

References throwException().

Referenced by openDataSet().

DataSet H5::H5Location::openDataSet ( const H5std_string & name ) const

References openDataSet().

Group H5::H5Location::openGroup ( const char * name ) const

Parameters

name	- IN: Name of the group to open

Returns: Group instance

Exceptions

H5::FileIException or H5::GroupIException

Examples:: h5group.cpp.

References throwException().

Referenced by openGroup().

Group H5::H5Location::openGroup ( const H5std_string & name ) const

References openGroup().

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

Note: This method is more suitable for an object reference.

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

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

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

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