Class Attribute operates on HDF5 attributes. More...

#include <H5Attribute.h>

Inheritance diagram for H5::Attribute:

Public Member Functions
	Attribute (const Attribute &original)
	Copy constructor: makes a copy of the original Attribute object. More...

	Attribute ()
	Default constructor: Creates a stub attribute. More...

	Attribute (const hid_t attr_id)
	Creates an Attribute object using the id of an existing attribute. More...

virtual void	close ()
	Closes this attribute. More...

ssize_t	getName (char *attr_name, size_t buf_size=0) const
	Gets the name of this attribute, returning its length. More...

H5std_string	getName (size_t len) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an integer specifying a desired length to be retrieved of the name. More...

H5std_string	getName () const
	Returns the name of this attribute as an H5std_string. More...

ssize_t	getName (H5std_string &attr_name, size_t len=0) const
	Gets the name of this attribute, returning its length. More...

ssize_t	getName (size_t buf_size, H5std_string &attr_name) const

virtual DataSpace	getSpace () const
	Gets a copy of the dataspace for this attribute. More...

virtual hsize_t	getStorageSize () const
	Returns the amount of storage size required for this attribute. More...

virtual size_t	getInMemDataSize () const
	Gets the size in memory of the attribute's data. More...

void	read (const DataType &mem_type, void *buf) const
	Reads data from this attribute. More...

void	read (const DataType &mem_type, H5std_string &strg) const
	This is an overloaded member function, provided for convenience. It reads a H5std_string from this attribute. More...

void	write (const DataType &mem_type, const void *buf) const
	Writes data to this attribute. More...

void	write (const DataType &mem_type, const H5std_string &strg) const
	This is an overloaded member function, provided for convenience. It writes a H5std_string to this attribute. More...

virtual H5std_string	fromClass () const
	Returns this class name. More...

virtual hid_t	getId () const
	Get the id of this attribute. More...

virtual	~Attribute ()
	Properly terminates access to this attribute. More...

Public Member Functions inherited from H5::AbstractDs
DataType	getDataType () const
	Returns the generic datatype of this abstract dataset, which can be a dataset or an attribute. More...

ArrayType	getArrayType () const
	Returns the array datatype of this abstract dataset which can be a dataset or an attribute. More...

CompType	getCompType () const
	Returns the compound datatype of this abstract dataset which can be a dataset or an attribute. More...

EnumType	getEnumType () const
	Returns the enumeration datatype of this abstract dataset which can be a dataset or an attribute. More...

IntType	getIntType () const
	Returns the integer datatype of this abstract dataset which can be a dataset or an attribute. More...

FloatType	getFloatType () const
	Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute. More...

StrType	getStrType () const
	Returns the string datatype of this abstract dataset which can be a dataset or an attribute. More...

VarLenType	getVarLenType () const
	Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute. More...

H5T_class_t	getTypeClass () const
	Creates an AbstractDs instance using an existing id. More...

virtual	~AbstractDs ()
	Noop destructor. More...

Public Member Functions inherited from H5::H5Location
bool	exists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Checks if a link of a given name exists in a location. More...

bool	exists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
	Checks if a link of a given name exists in a location. 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 this HDF5 object 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
	Retrieves a dataspace with the region pointed to selected. More...

Group	createGroup (const char *name, size_t size_hint=0) const
	Creates a new group at this location which can be a file or another group. More...

Group	createGroup (const H5std_string &name, size_t size_hint=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...

Group	openGroup (const char *name) const
	Opens an existing group in a location which can be a file or another group. More...

Group	openGroup (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...

DataSet	createDataSet (const char *name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) const
	Creates a new dataset at this location. More...

DataSet	createDataSet (const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT) 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...

DataSet	openDataSet (const char *name) const
	Opens an existing dataset at this location. More...

DataSet	openDataSet (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...

H5std_string	getLinkval (const char *link_name, size_t size=0) const
	Returns the name of the object that the symbolic link points to. More...

H5std_string	getLinkval (const H5std_string &link_name, size_t 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...

int	getNumAttrs () const
	Returns the number of attributes attached to this HDF5 object. More...

H5std_string	getObjnameByIdx (hsize_t idx) const
	Returns the name of an object in this group, given the object's index. More...

ssize_t	getObjnameByIdx (hsize_t idx, char *name, size_t size) const
	Retrieves the name of an object in this group, given the object's index. More...

ssize_t	getObjnameByIdx (hsize_t idx, H5std_string &name, size_t size) 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...

H5O_type_t	childObjType (const H5std_string &objname) const
	This is an overloaded member function, provided for convenience. It takes an H5std_string for the object's name. More...

H5O_type_t	childObjType (const char *objname) const
	Returns the type of an object in this file/group, given the object's name. More...

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
	Returns the type of an object in this file/group, given the object's index and its type and order. More...

unsigned	childObjVersion (const char *objname) const
	Returns the object header version of an object in this file/group, given the object's name. More...

unsigned	childObjVersion (const H5std_string &objname) const
	This is an overloaded member function, provided for convenience. It takes an H5std_string for the object's name. More...

H5G_obj_t	getObjTypeByIdx (hsize_t idx) const
	Returns the type of an object in this group, given the object's index. More...

H5G_obj_t	getObjTypeByIdx (hsize_t idx, char *type_name) const
	This is an overloaded member function, provided for convenience. It differs from the above function because it also provides the returned object type in text (char*) More...

H5G_obj_t	getObjTypeByIdx (hsize_t idx, H5std_string &type_name) const
	This is an overloaded member function, provided for convenience. It differs from the above function because it also provides the returned object type in text (H5std_string&) More...

void	getObjinfo (const char *name, hbool_t follow_link, H5G_stat_t &statbuf) const
	Returns information about an object. More...

void	getObjinfo (const H5std_string &name, hbool_t follow_link, H5G_stat_t &statbuf) 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	getObjinfo (const char *name, H5G_stat_t &statbuf) const
	This is an overloaded member function, provided for convenience. It differs from the above functions in that it doesn't have the paramemter follow_link. More...

void	getObjinfo (const H5std_string &name, H5G_stat_t &statbuf) 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...

int	iterateElems (const char name, int idx, H5G_iterate_t op, void *op_data)
	Iterates a user's function over the entries of a group. More...

int	iterateElems (const H5std_string &name, int idx, H5G_iterate_t op, void op_data)
	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	link (H5L_type_t link_type, const char curr_name, const char new_name) const
	Creates a link of the specified type from new_name to curr_name. More...

void	link (H5L_type_t link_type, const H5std_string &curr_name, const H5std_string &new_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 curr_name and new_name. More...

void	unlink (const char *name) const
	Removes the specified name at this location. More...

void	unlink (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	mount (const char *name, const H5File &child, const PropList &plist) const
	Mounts the file child onto this group. More...

void	mount (const H5std_string &name, const H5File &child, const PropList &plist) const
	This is an overloaded member function, provided for convenience. It takes an `H5std_string` for name. More...

void	unmount (const char *name) const
	Unmounts the specified file. More...

void	unmount (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	move (const char src, const char dst) const
	Renames an object at this location. More...

void	move (const H5std_string &src, const H5std_string &dst) const
	This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an `H5std_string` for src and dst. More...

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

Friends
void	f_Attribute_setId (Attribute *attr, hid_t new_id)

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

Protected Member Functions inherited from H5::AbstractDs
	AbstractDs ()
	Default constructor. More...

Protected Member Functions inherited from H5::H5Location
virtual	~H5Location ()

Detailed Description

An attribute has many characteristics similar to a dataset, thus both Attribute and DataSet are derivatives of AbstractDs. Attribute also inherits from H5Location because an attribute can be used to specify a location.

Constructor & Destructor Documentation

H5::Attribute::Attribute ( const Attribute & original )

Parameters

original - IN: Original Attribute object to copy

References H5::IdComponent::incRefCount().

H5::Attribute::Attribute ( )

H5::Attribute::Attribute ( const hid_t existing_id )

Parameters

existing_id - IN: Id of an existing attribute

Exceptions

H5::AttributeIException

References H5::IdComponent::incRefCount().

H5::Attribute::~Attribute ( )

virtual

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

Member Function Documentation

void H5::Attribute::close ( )

virtual

Exceptions

H5::AttributeIException

Referenced by ~Attribute().

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

inlinevirtual

Implements H5::AbstractDs.

hid_t H5::Attribute::getId ( ) const

virtual

Returns: Attribute identifier

Referenced by H5::DataSet::DataSet().

size_t H5::Attribute::getInMemDataSize ( ) const

virtual

Returns: Size of data (in memory)

Exceptions

H5::AttributeIException

Implements H5::AbstractDs.

ssize_t H5::Attribute::getName	(	char *	attr_name,
		size_t	buf_size = `0`
	)		const

Parameters

attr_name	- OUT: Buffer for the name string as char*
buf_size	- IN: Length of the buffer, default to 0

Returns: Actual length of the attribute name

Exceptions

H5::AttributeIException

Description: This function retrieves buf_size chars of the attribute's name including null termination. Thus, if the actual length of the name is more than buf_size-1, the retrieved name will be truncated to accommodate the null terminator. To get length of the attribute's name for buffer allocation, an application can call this function passing in NULL for the first argument and ignore the second argument.

H5std_string H5::Attribute::getName ( size_t len ) const

Returns: Name (or part of name) of the attribute

Parameters

len	- IN: Desired length of the name

Exceptions

H5::AttributeIException

References getName().

H5std_string H5::Attribute::getName ( ) const

Returns: Name of the attribute

Exceptions

H5::AttributeIException

Referenced by getName().

ssize_t H5::Attribute::getName	(	H5std_string &	attr_name,
		size_t	len = `0`
	)		const

Parameters

attr_name	- OUT: Buffer for the name string as H5std_string
len	- IN: Desired length of the name, default to 0

Returns: Actual length of the attribute name

Exceptions

H5::AttributeIException

Description: This function retrieves the attribute's name as a string. The buf_size can specify a specific length or default to 0, in which case the entire name will be retrieved.

References getName().

ssize_t H5::Attribute::getName	(	size_t	buf_size,
		H5std_string &	attr_name
	)		const

DataSpace H5::Attribute::getSpace ( ) const

virtual

Returns: Dataspace instance

Exceptions

H5::AttributeIException

Implements H5::AbstractDs.

hsize_t H5::Attribute::getStorageSize ( ) const

virtual

Returns: Size of the storage or 0, for no data

Exceptions

H5::AttributeIException

Implements H5::AbstractDs.

void H5::Attribute::read	(	const DataType &	mem_type,
		void *	buf
	)		const

Parameters

mem_type	- IN: Attribute datatype (in memory)
buf	- OUT: Buffer for read data

Exceptions

H5::AttributeIException

References H5::DataType::getId().

void H5::Attribute::read	(	const DataType &	mem_type,
		H5std_string &	strg
	)		const

Parameters

mem_type	- IN: Attribute datatype (in memory)
strg	- IN: Buffer for read string

Exceptions

H5::AttributeIException

References H5::DataType::getId().

void H5::Attribute::write	(	const DataType &	mem_type,
		const void *	buf
	)		const

Parameters

mem_type	- IN: Attribute datatype (in memory)
buf	- IN: Data to be written

Exceptions

H5::AttributeIException

References H5::DataType::getId().

void H5::Attribute::write	(	const DataType &	mem_type,
		const H5std_string &	strg
	)		const

Parameters

mem_type	- IN: Attribute datatype (in memory)
strg	- IN: Data to be written

Exceptions

H5::AttributeIException

References H5::DataType::getId().

Friends And Related Function Documentation

void f_Attribute_setId	(	Attribute *	attr,
		hid_t	new_id
	)

friend

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

H5Attribute.h
H5Attribute.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation