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

bool H5::H5Location::attrExists ( const H5std_string & name ) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name.

Attribute H5::H5Location::createAttribute	(	const char *	name,
		const DataType &	data_type,
		const DataSpace &	data_space,
		const PropList &	create_plist = `PropList::DEFAULT`
	)		const

Creates an attribute for a group, dataset, or named datatype.

Parameters

name	- IN: Name of the attribute
data_type	- IN: Datatype for the attribute
data_space	- IN: Dataspace for the attribute - only simple dataspaces are allowed at this time
create_plist	- IN: Creation property list - default to PropList::DEFAULT

Returns: Attribute instance

Exceptions

Description: The attribute name specified in name must be unique. Attempting to create an attribute with the same name as an existing attribute will raise an exception, leaving the pre-existing attribute intact. To overwrite an existing attribute with a new attribute of the same name, first delete the existing one with H5Location::removeAttr, then recreate it with this function.

Attribute H5::H5Location::createAttribute	(	const H5std_string &	name,
		const DataType &	type,
		const DataSpace &	space,
		const PropList &	create_plist = `PropList::DEFAULT`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name.

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

Dereferences a reference into an HDF5 object, given an HDF5 object.

Parameters

loc	- IN: Location of the referenced object
ref	- IN: Reference pointer
ref_type	- IN: Reference type

Exceptions

void H5::H5Location::dereference	(	const Attribute &	attr,
		const void *	ref,
		H5R_type_t	ref_type = `H5R_OBJECT`
	)

Dereferences a reference into an HDF5 object, given an attribute.

Parameters

attr	- IN: Attribute specifying the location of the referenced object
ref	- IN: Reference pointer
ref_type	- IN: Reference type

Exceptions

void H5::H5Location::flush ( H5F_scope_t scope ) const

Flushes all buffers associated with a location to disk.

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.

H5std_string H5::H5Location::getComment	(	const char *	name,
		size_t	bufsize = `256`
	)		const

Retrieves comment for the specified object and its comment's length.

Parameters

name	- IN: Name of the object
bufsize	- IN: Length of the comment to retrieve

Returns: Comment string

Exceptions

H5std_string H5::H5Location::getComment	(	const H5std_string &	name,
		size_t	bufsize = `256`
	)		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.

H5std_string H5::H5Location::getFileName ( ) const

Gets the name of the file, in which this HDF5 object belongs.

Returns: File name

Exceptions

H5::IdComponentException

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

pure virtual

Returns an identifier. (pure virtual)

Implements H5::IdComponent.

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

int H5::H5Location::getNumAttrs ( ) const

Returns the number of attributes attached to this HDF5 object.

Returns: Number of attributes

Exceptions

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

Retrieves the type of object that an object reference points to.

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

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

Retrieves the type of object that an object reference points to.

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

Retrieves a dataspace with the region pointed to selected.

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::iterateAttrs	(	attr_operator_t	user_op,
		unsigned *	_idx = `NULL`,
		void *	op_data = `NULL`
	)

Iterates a user's function over all the attributes of an H5 object, which may be a group, dataset or named datatype.

Parameters

user_op	- IN: User's function to operate on each attribute
_idx	- IN/OUT: Starting (IN) and ending (OUT) attribute indices
op_data	- IN: User's data to pass to user's operator function

Returns: Returned value of the last operator if it was non-zero, or zero if all attributes were processed

Exceptions

Description: The signature of user_op is void (*)(H5::H5Location&, H5std_string, void*). For information, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Iterate

Attribute H5::H5Location::openAttribute ( const char * name ) const

Opens an attribute given its name.

Parameters

name	- IN: Name of the attribute

Returns: Attribute instance

Exceptions

Attribute H5::H5Location::openAttribute ( const H5std_string & name ) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name.

Attribute H5::H5Location::openAttribute ( const unsigned int idx ) const

Opens an attribute given its index.

Parameters

idx	- IN: Index of the attribute, a 0-based, non-negative integer

Returns: Attribute instance

Exceptions

hid_t H5::H5Location::p_dereference	(	hid_t	loc_id,
		const void *	ref,
		H5R_type_t	ref_type,
		const char *	from_func
	)

protected

H5G_obj_t H5::H5Location::p_get_obj_type	(	void *	ref,
		H5R_type_t	ref_type
	)		const

protected

H5O_type_t H5::H5Location::p_get_ref_obj_type	(	void *	ref,
		H5R_type_t	ref_type
	)		const

protected

void H5::H5Location::p_reference	(	void *	ref,
		const char *	name,
		hid_t	space_id,
		H5R_type_t	ref_type
	)		const

protected

void H5::H5Location::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.

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.

void H5::H5Location::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.

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.

void H5::H5Location::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.

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.

void H5::H5Location::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.

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.

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

Removes the named attribute from this object.

Parameters

name	- IN: Name of the attribute to be removed

Exceptions

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

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for name.

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

Removes the comment from an object specified by its name.

Parameters

name	- IN: Name of the object

Exceptions

void H5::H5Location::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.

void H5::H5Location::renameAttr	(	const char *	oldname,
		const char *	newname
	)		const

Renames the named attribute from this object.

Parameters

oldname	- IN: Name of the attribute to be renamed
newname	- IN: New name ame of the attribute

Exceptions

void H5::H5Location::renameAttr	(	const H5std_string &	oldname,
		const H5std_string &	newname
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes a reference to an H5std_string for the names.

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

Sets or resets the comment for an object specified by its name.

Parameters

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

Exceptions