My Project: H5::H5Location Class Reference

◆ exists() [1/2]

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

◆ exists() [2/2]

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

◆ flush()

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

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

◆ getComment() [1/3]

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

◆ getComment() [2/3]

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

◆ getComment() [3/3]

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

References getComment().

◆ getFileName()

H5std_string H5::H5Location::getFileName ( ) const

Returns: File name

Exceptions

◆ getLinkInfo() [1/2]

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

Parameters

link_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/H5::GroupIException/H5::LocationException

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

Referenced by getLinkInfo().

◆ getLinkInfo() [2/2]

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

References getLinkInfo().

◆ getLinkval() [1/2]

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/H5::GroupIException/H5::LocationException

References throwException().

Referenced by getLinkval().

◆ getLinkval() [2/2]

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

References getLinkval().

◆ getNumObjs()

hsize_t H5::H5Location::getNumObjs ( ) const

Returns: Deprecated

Exceptions

Deprecated

References throwException().

◆ getObjinfo() [1/9]

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

Parameters

grp_name	- IN: Group name where the object belongs - `char` *
idx_type	- IN: Type of index
order	- IN: Order to traverse
idx	- IN: Object position
objinfo	- OUT: Struct containing the object info
fields	- IN: Indicates the group of information to be retrieved default to H5O_INFO_BASIC
lapl	- IN: Link access property list

Description

Valid values of fields are as follows:

H5O_INFO_BASIC (default)
H5O_INFO_TIME
H5O_INFO_NUM_ATTRS
H5O_INFO_HDR
H5O_INFO_META_SIZE
H5O_INFO_ALL

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

◆ getObjinfo() [2/9]

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

References throwException().

◆ getObjinfo() [3/9]

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

Parameters

name	- IN: Name of the object to be queried - `char` *
objinfo	- OUT: Struct containing the object info
fields	- IN: Indicates the group of information to be retrieved default to H5O_INFO_BASIC
lapl	- IN: Link access property list

Description

Valid values of fields are as follows:

H5O_INFO_BASIC (default)
H5O_INFO_TIME
H5O_INFO_NUM_ATTRS
H5O_INFO_HDR
H5O_INFO_META_SIZE
H5O_INFO_ALL

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

◆ getObjinfo() [4/9]

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/H5::GroupIException/H5::LocationException

Description: For information, please refer to the H5Gget_objinfo API in the HDF5 C Reference Manual.

References throwException().

◆ getObjinfo() [5/9]

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

Parameters

name	- IN: Name of the object to be queried - `H5std_string`
objinfo	- OUT: Struct containing the object info
fields	- IN: Indicates a group of information to be retrieved default to H5O_INFO_BASIC
lapl	- IN: Link access property list

References getObjinfo().

◆ getObjinfo() [6/9]

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

References getObjinfo().

◆ getObjinfo() [7/9]

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

Parameters

name	- IN: Name of the object to be queried - `H5std_string`
objinfo	- OUT: Struct containing the object info
fields	- IN: Indicates the group of information to be retrieved default to H5O_INFO_BASIC
lapl	- IN: Link access property list

References getObjinfo().

◆ getObjinfo() [8/9]

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

References getObjinfo().

◆ getObjinfo() [9/9]

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

Parameters

objinfo	- OUT: Struct containing the object info
fields	- IN: Indicates the group of information to be retrieved

Description

Valid values of fields are as follows:

H5O_INFO_BASIC (default)
H5O_INFO_TIME
H5O_INFO_NUM_ATTRS
H5O_INFO_HDR
H5O_INFO_META_SIZE
H5O_INFO_ALL

References throwException().

Referenced by getObjinfo().

◆ getObjnameByIdx() [1/3]

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

Parameters

idx	- IN: Transient index of the object

Returns: Object name

Exceptions

H5::FileIException/H5::GroupIException/H5::LocationException

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

◆ getObjnameByIdx() [2/3]

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/H5::GroupIException/H5::LocationException

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

◆ getObjnameByIdx() [3/3]

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

References getObjnameByIdx(), and throwException().

◆ getObjType()

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

◆ getObjTypeByIdx() [1/3]

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

Parameters

idx	- IN: Transient index of the object

Returns: Object type

Exceptions

H5::FileIException/H5::GroupIException/H5::LocationException

References throwException().

Referenced by getObjTypeByIdx().

◆ getObjTypeByIdx() [2/3]

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/H5::GroupIException/H5::LocationException

References getObjTypeByIdx().

◆ getObjTypeByIdx() [3/3]

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/H5::GroupIException/H5::LocationException

References throwException().

◆ getRefObjType()

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

◆ getRegion()

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

References H5::f_DataSpace_setId(), and H5::Exception::getDetailMsg().

◆ iterateElems() [1/2]

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/H5::GroupIException/H5::LocationException

References throwException().

Referenced by iterateElems().

◆ iterateElems() [2/2]

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

References iterateElems().

◆ link() [1/8]

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

Parameters

curr_name	- IN: Name of the existing object
new_loc	- IN: New group or root group
new_name	- IN: New name for the object
lcpl	- IN: Link creation plist - default to LinkCreatPropList::DEFAULT
lapl	- IN: Link access plist - default to LinkAccPropList::DEFAULT

Exceptions

H5::FileIException or H5::GroupIException

Description: Note that both names are interpreted relative to the specified location. For information on creating a hard link, please refer to the H5Lcreate_hard APIs in the HDF5 C Reference Manual.

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

◆ link() [2/8]

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

Parameters

curr_name	- IN: Name of the existing object
loc_id	- IN: Group or root group ID, or H5L_SAME_LOC
new_name	- IN: New name for the link
lcpl	- IN: Link creation plist - default to LinkCreatPropList::DEFAULT
lapl	- IN: Link access plist - default to LinkAccPropList::DEFAULT

Exceptions

H5::FileIException or H5::GroupIException

Description: Note that both names are interpreted relative to the specified location. For information on creating a hard link, please refer to the H5Lcreate_hard APIs in the HDF5 C Reference Manual.

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

◆ link() [3/8]

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

Parameters

target_name	- IN: Name of object, can be a non-existing object
link_name	- IN: Link name for the target name
lcpl	- IN: Link creation plist - default to LinkCreatPropList::DEFAULT
lapl	- IN: Link access plist - default to LinkAccPropList::DEFAULT

Exceptions

H5::FileIException or H5::GroupIException

Description: Note that both names are interpreted relative to the current location. For information on creating a soft link, please refer to the H5Lcreate_soft APIs in the HDF5 C Reference Manual.

Examples: h5group.cpp.

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

Referenced by link().

◆ link() [4/8]

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

Exceptions

H5::FileIException or H5::GroupIException

References link().

◆ link() [5/8]

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

Exceptions

H5::FileIException or H5::GroupIException

References link().

◆ link() [6/8]

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

Exceptions

H5::FileIException or H5::GroupIException

References link().

◆ link() [7/8]

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/H5::GroupIException/H5::LocationException

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 H5Lcreate_hard and H5Lcreate_soft APIs in the HDF5 C Reference Manual.

References throwException().

◆ link() [8/8]

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

References link().

◆ mount() [1/2]

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::PropList::getId(), H5::H5File::getId(), and throwException().

Referenced by mount().

◆ mount() [2/2]

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

References mount().

◆ move() [1/2]

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/H5::GroupIException/H5::LocationException

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 Guide for details.

References H5::LinkAccPropList::DEFAULT, H5::LinkCreatPropList::DEFAULT, and moveLink().

◆ move() [2/2]

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

References H5::LinkAccPropList::DEFAULT, H5::LinkCreatPropList::DEFAULT, and moveLink().

◆ moveLink() [1/4]

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

Parameters

src_name	- IN: Original name
dst_name	- IN: New name
lcpl	- IN: Link creation plist - default LinkCreatPropList::DEFAULT
lapl	- IN: Link access plist - default LinkAccPropList::DEFAULT

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::moveLink. Please refer to the Group Interface in the HDF5 User Guide for details.

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

◆ moveLink() [2/4]

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

Parameters

src_name	- IN: Original name
dst	- IN: Destination location
dst_name	- IN: New name
lcpl	- IN: Link creation plist - default LinkCreatPropList::DEFAULT
lapl	- IN: Link access plist - default LinkAccPropList::DEFAULT

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::moveLink. Please refer to the Group Interface in the HDF5 User Guide for details.

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

Referenced by move(), and moveLink().

◆ moveLink() [3/4]

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

Exceptions

H5::FileIException or H5::GroupIException

References moveLink().

◆ moveLink() [4/4]

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

Exceptions

H5::FileIException or H5::GroupIException

References moveLink().

◆ nameExists() [1/2]

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

References H5::PropList::getId().

Referenced by exists(), and nameExists().

◆ nameExists() [2/2]

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

References nameExists().

◆ openDataSet() [1/2]

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

Parameters

name	- IN: Name of the dataset to open

Returns: DataSet instance

Exceptions

H5::FileIException/H5::GroupIException/H5::LocationException

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

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

Referenced by openDataSet().

◆ openDataSet() [2/2]

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

References openDataSet().

◆ openGroup() [1/2]

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

Parameters

name	- IN: Name of the group to open

Returns: Group instance

Exceptions

H5::FileIException/H5::GroupIException/H5::LocationException

Examples: h5group.cpp.

References throwException().

Referenced by openGroup().

◆ openGroup() [2/2]

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

References openGroup().

◆ reference() [1/4]

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

◆ reference() [2/4]

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

◆ reference() [3/4]

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

◆ reference() [4/4]

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

◆ removeComment() [1/2]

void H5::H5Location::removeComment ( const char * name ) const

Parameters

name	- IN: Name of the object

Exceptions

Referenced by removeComment().

◆ removeComment() [2/2]

void H5::H5Location::removeComment ( const H5std_string & name ) const

References removeComment().

◆ setComment() [1/4]

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

◆ setComment() [2/4]

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

Parameters

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

Exceptions