Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes. More...

#include <H5ArrayType.h>

Inheritance diagram for H5::ArrayType:

Public Member Functions
	ArrayType (const DataType &base_type, int ndims, const hsize_t *dims)
	Creates a new array data type based on the specified base_type. More...

int	getArrayNDims ()
	Returns the number of dimensions for an array datatype. More...

int	getArrayDims (hsize_t *dims)
	Retrieves the size of all dimensions of an array datatype. More...

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

	ArrayType (const ArrayType &original)
	Copy constructor: makes a copy of the original ArrayType object. More...

	ArrayType (const hid_t existing_id)
	Creates an ArrayType object using an existing id. More...

virtual	~ArrayType ()
	Properly terminates access to this array datatype. More...

Public Member Functions inherited from H5::DataType
	DataType (const H5T_class_t type_class, size_t size)
	Creates a object given its class and size. More...

	DataType (const DataType &original)
	Copy constructor: makes a copy of the original DataType object. More...

	DataType (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a DataType object. More...

	DataType (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Given a reference, ref, to an hdf5 group, creates a DataType object. More...

virtual void	close ()
	Closes the datatype if it is not a predefined type. More...

void	copy (const DataType &like_type)
	Copies an existing datatype to this datatype object. More...

void	copy (const DataSet &dset)
	Copies the datatype of the given dataset to this datatype object. More...

H5T_class_t	getClass () const
	Returns the datatype class identifier. More...

void	commit (H5Location &loc, const char *name)
	Commits a transient datatype to a file, creating a new named datatype. More...

void	commit (H5Location &loc, const H5std_string &name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

bool	committed () const
	Determines whether a datatype is a named type or a transient type. More...

H5T_conv_t	find (const DataType &dest, H5T_cdata_t **pcdata) const
	Finds a conversion function that can handle a conversion from this datatype to the specified datatype, dest. More...

void	convert (const DataType &dest, size_t nelmts, void buf, void background, const PropList &plist=PropList::DEFAULT) const
	Converts data from this datatype to the specified datatypes. More...

DataType &	operator= (const DataType &rhs)
	Assignment operator. More...

bool	operator== (const DataType &compared_type) const
	Compares this DataType against the given one to determines whether the two objects refer to the same actual datatype. More...

void	lock () const
	Locks a datatype, making it read-only and non-destructible. More...

size_t	getSize () const
	Returns the size of a datatype. More...

DataType	getSuper () const
	Returns the base datatype from which a datatype is derived. More...

void	registerFunc (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
	Registers the specified conversion function. More...

void	registerFunc (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

void	unregister (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
	Removes a conversion function from all conversion paths. More...

void	unregister (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

void	setTag (const char *tag) const
	Tags an opaque datatype. More...

void	setTag (const H5std_string &tag) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

H5std_string	getTag () const
	Gets the tag associated with an opaque datatype. More...

bool	detectClass (H5T_class_t cls) const
	Checks whether a datatype contains (or is) a certain type of datatype. More...

bool	isVariableStr () const
	Check whether this datatype is a variable-length string. More...

	DataType (const hid_t type_id)
	Creates a datatype using an existing datatype's id. More...

	DataType ()
	Default constructor: Creates a stub datatype. More...

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

virtual	~DataType ()
	Properly terminates access to this datatype. More...

Public Member Functions inherited from H5::H5Object
	H5Object (const H5Object &original)
	Copy constructor: makes a copy of the original H5Object instance. More...

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

Public Member Functions inherited from H5::H5Location
Attribute	createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
	Creates an attribute for a group, dataset, or named datatype. More...

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

Attribute	openAttribute (const char *name) const
	Opens an attribute given its name. More...

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

Attribute	openAttribute (const unsigned int idx) const
	Opens an attribute given its index. 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...

int	getNumAttrs () const
	Returns the number of attributes attached to this HDF5 object. 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...

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

bool	attrExists (const char *name) const
	Checks whether the named attribute exists at this location. More...

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

void	renameAttr (const char oldname, const char newname) const
	Renames the named attribute from this object. More...

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

void	removeAttr (const char *name) const
	Removes the named attribute from this object. More...

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

H5std_string	getComment (const char *name, size_t bufsize=256) const
	Retrieves comment for the specified object and its comment's length. More...

H5std_string	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. 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)
	Dereferences a reference into an HDF5 object, given an HDF5 object. More...

void	dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
	Dereferences a reference into an HDF5 object, given an attribute. More...

DataSpace	getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
	Retrieves a dataspace with the region pointed to selected. More...

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

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

	IdComponent (const hid_t h5_id)
	Creates an IdComponent object using the id of an existing object. More...

	IdComponent (const IdComponent &original)
	Copy constructor: makes a copy of the original IdComponent object. More...

H5std_string	inMemFunc (const char *func_name) const
	Makes and returns string "<class-name>::<func_name>". More...

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

Protected Member Functions
	ArrayType ()
	Default constructor: Creates a stub ArrayType. More...

Protected Member Functions inherited from H5::DataType
virtual void	p_setId (const hid_t new_id)
	Sets the identifier of this object to a new value. More...

Protected Member Functions inherited from H5::H5Object
	H5Object ()

	H5Object (const hid_t object_id)

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

	H5Location (const hid_t loc_id)

	H5Location (const H5Location &original)
	Copy constructor: makes a copy of the original H5Location instance. More...

void	p_reference (void ref, const char name, hid_t space_id, H5R_type_t ref_type) const

hid_t	p_dereference (hid_t loc_id, const void ref, H5R_type_t ref_type, const char from_func)

H5G_obj_t	p_get_obj_type (void *ref, H5R_type_t ref_type) const

H5O_type_t	p_get_ref_obj_type (void *ref, H5R_type_t ref_type) const

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

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

H5std_string	p_get_file_name () const

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 Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)

Protected Attributes inherited from H5::DataType
hid_t	id

Detailed Description

Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes.

Constructor & Destructor Documentation

H5::ArrayType::ArrayType	(	const DataType &	base_type,
		int	ndims,
		const hsize_t *	dims
	)

Creates a new array data type based on the specified base_type.

Parameters

base_type	- IN: Existing datatype
ndims	- IN: Rank of the array, [0..H5S_MAX_RANK]
dims	- IN: Size of each array dimension

Exceptions

H5::DataTypeIException

H5::ArrayType::ArrayType ( const ArrayType & original )

Copy constructor: makes a copy of the original ArrayType object.

H5::ArrayType::ArrayType ( const hid_t existing_id )

Creates an ArrayType object using an existing id.

Parameters

existing_id - IN: Id of an existing datatype

Exceptions

H5::DataTypeIException

H5::ArrayType::~ArrayType ( )

virtual

Properly terminates access to this array datatype.

H5::ArrayType::ArrayType ( )

protected

Default constructor: Creates a stub ArrayType.

Member Function Documentation

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

inlinevirtual

Returns this class name.

Reimplemented from H5::DataType.

int H5::ArrayType::getArrayDims ( hsize_t * dims )

Retrieves the size of all dimensions of an array datatype.

Parameters

dims	- OUT: Sizes of dimensions

Returns: Number of dimensions

Exceptions

H5::DataTypeIException

int H5::ArrayType::getArrayNDims ( )

Returns the number of dimensions for an array datatype.

Returns: Number of dimensions

Exceptions

H5::DataTypeIException

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation