Class DataSet operates on HDF5 datasets. More...

#include <H5DataSet.h>

Inheritance diagram for H5::DataSet:

Public Member Functions
virtual void	close ()
	Closes this dataset. More...

void	extend (const hsize_t *size) const
	Extends a dataset with unlimited dimension. More...

void	fillMemBuf (const void fill, const DataType &fill_type, void buf, const DataType &buf_type, const DataSpace &space) const
	Fills a selection in memory with a value. More...

void	fillMemBuf (void *buf, const DataType &buf_type, const DataSpace &space) const
	Fills a selection in memory with 0. More...

DSetCreatPropList	getCreatePlist () const
	Gets the dataset creation property list. More...

haddr_t	getOffset () const
	Returns the address of this dataset in the file. More...

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

void	getSpaceStatus (H5D_space_status_t &status) const
	Determines whether space has been allocated for a dataset. More...

virtual hsize_t	getStorageSize () const
	Returns the amount of storage required for a dataset. More...

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

hsize_t	getVlenBufSize (const DataType &type, const DataSpace &space) const
	Returns the number of bytes required to store VL data. More...

void	read (void *buf, const DataType &mem_type, const DataSpace &mem_space=DataSpace::ALL, const DataSpace &file_space=DataSpace::ALL, const DSetMemXferPropList &xfer_plist=DSetMemXferPropList::DEFAULT) const
	Reads raw data from the specified dataset. More...

void	read (H5std_string &buf, const DataType &mem_type, const DataSpace &mem_space=DataSpace::ALL, const DataSpace &file_space=DataSpace::ALL, const DSetMemXferPropList &xfer_plist=DSetMemXferPropList::DEFAULT) const
	This is an overloaded member function, provided for convenience. It takes a reference to a `H5std_string` for the buffer. More...

void	write (const void *buf, const DataType &mem_type, const DataSpace &mem_space=DataSpace::ALL, const DataSpace &file_space=DataSpace::ALL, const DSetMemXferPropList &xfer_plist=DSetMemXferPropList::DEFAULT) const
	Writes raw data from an application buffer to a dataset. More...

void	write (const H5std_string &buf, const DataType &mem_type, const DataSpace &mem_space=DataSpace::ALL, const DataSpace &file_space=DataSpace::ALL, const DSetMemXferPropList &xfer_plist=DSetMemXferPropList::DEFAULT) const
	This is an overloaded member function, provided for convenience. It takes a reference to a `H5std_string` for the buffer. More...

int	iterateElems (void buf, const DataType &type, const DataSpace &space, H5D_operator_t op, void op_data=NULL)
	Iterates over all selected elements in a dataspace. More...

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

	DataSet (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT, const PropList &plist=PropList::DEFAULT)
	Given a reference, ref, to an hdf5 location, creates a DataSet object. More...

	DataSet (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT, const PropList &plist=PropList::DEFAULT)
	Given a reference, ref, to an hdf5 attribute, creates a DataSet object. More...

	DataSet ()
	Default constructor: creates a stub DataSet. More...

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

	DataSet (const hid_t existing_id)
	Creates an DataSet object using the id of an existing dataset. More...

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

virtual	~DataSet ()
	Properly terminates access to this dataset. More...

Public Member Functions inherited from H5::H5Object
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...

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

unsigned	objVersion () const
	Returns the header version of this HDF5 object. 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...

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

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

Static Public Member Functions
static void	vlenReclaim (const DataType &type, const DataSpace &space, const DSetMemXferPropList &xfer_plist, void *buf)
	Reclaims VL datatype memory buffers. More...

static void	vlenReclaim (void *buf, const DataType &type, const DataSpace &space=DataSpace::ALL, const DSetMemXferPropList &xfer_plist=DSetMemXferPropList::DEFAULT)
	Reclaims VL datatype memory buffers. More...

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

Friends
void	f_DataSet_setId (DataSet *dset, hid_t new_id)

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

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

Detailed Description

A dataset has many characteristics similar to an attribute, thus both Attribute and DataSet are derivatives of AbstractDs. DataSet also inherits from H5Object because a dataset is an HDF5 object.

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

Constructor & Destructor Documentation

H5::DataSet::DataSet	(	const H5Location &	loc,
		const void *	ref,
		H5R_type_t	ref_type = `H5R_OBJECT`,
		const PropList &	plist = `PropList::DEFAULT`
	)

Parameters

loc	- IN: Dataset reference object is in or location of object that the dataset is located within.
ref	- IN: Reference pointer
ref_type	- IN: Reference type - default to H5R_OBJECT
plist	- IN: Property list - default to PropList::DEFAULT

Exceptions

H5::DataSetIException

Description: loc can be DataSet, Group, H5File, or named DataType, that is a datatype that has been named by DataType::commit.

H5::DataSet::DataSet	(	const Attribute &	attr,
		const void *	ref,
		H5R_type_t	ref_type = `H5R_OBJECT`,
		const PropList &	plist = `PropList::DEFAULT`
	)

Parameters

attr	- IN: Specifying location where the referenced object is in
ref	- IN: Reference pointer
ref_type	- IN: Reference type - default to H5R_OBJECT
plist	- IN: Property list - default to PropList::DEFAULT

Exceptions

H5::ReferenceException

References H5::Attribute::getId().

H5::DataSet::DataSet ( )

H5::DataSet::DataSet ( const DataSet & original )

Parameters

original - IN: DataSet instance to copy

References H5::IdComponent::incRefCount().

H5::DataSet::DataSet ( const hid_t existing_id )

Parameters

existing_id - IN: Id of an existing dataset

References H5::IdComponent::incRefCount().

H5::DataSet::~DataSet ( )

virtual

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

Member Function Documentation

void H5::DataSet::close ( )

virtual

Exceptions

H5::DataSetIException

Referenced by ~DataSet().

void H5::DataSet::extend ( const hsize_t * size ) const

Parameters

size	- IN: Array containing the new magnitude of each dimension

Exceptions

H5::DataSetIException

Description: For more information, please see the Description section in C layer Reference Manual at:

: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Extend

Examples:: extend_ds.cpp.

void H5::DataSet::fillMemBuf	(	const void *	fill,
		const DataType &	fill_type,
		void *	buf,
		const DataType &	buf_type,
		const DataSpace &	space
	)		const

Parameters

fill	- IN: Pointer to fill value to use - default NULL
fill_type	- IN: Datatype of the fill value
buf	- IN/OUT: Memory buffer to fill selection within
buf_type	- IN: Datatype of the elements in buffer
space	- IN: Dataspace describing memory buffer & containing selection to use

Exceptions

H5::DataSetIException

References H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::fillMemBuf	(	void *	buf,
		const DataType &	buf_type,
		const DataSpace &	space
	)		const

Parameters

buf	- IN/OUT: Memory buffer to fill selection within
buf_type	- IN: Datatype of the elements in buffer
space	- IN: Dataspace describing memory buffer & containing selection to use

Exceptions

H5::DataSetIException

References H5::DataSpace::getId(), and H5::DataType::getId().

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

inlinevirtual

Implements H5::AbstractDs.

DSetCreatPropList H5::DataSet::getCreatePlist ( ) const

Returns: DSetCreatPropList instance

Exceptions

H5::DataSetIException

Examples:: chunks.cpp.

hid_t H5::DataSet::getId ( ) const

virtual

Returns: DataSet identifier

Implements H5::H5Object.

Referenced by H5::CompType::CompType(), H5::DataType::copy(), H5::EnumType::EnumType(), H5::FloatType::FloatType(), H5::IntType::IntType(), and H5::StrType::StrType().

size_t H5::DataSet::getInMemDataSize ( ) const

virtual

Returns: Size of data (in memory)

Exceptions

H5::DataSetIException

Implements H5::AbstractDs.

haddr_t H5::DataSet::getOffset ( ) const

Returns: Address of dataset

Exceptions

H5::DataSetIException

DataSpace H5::DataSet::getSpace ( ) const

virtual

Returns: DataSpace instance

Exceptions

H5::DataSetIException

Implements H5::AbstractDs.

Examples:: chunks.cpp, extend_ds.cpp, readdata.cpp, and writedata.cpp.

void H5::DataSet::getSpaceStatus ( H5D_space_status_t & status ) const

Parameters

status - OUT: Space allocation status

Exceptions

H5::DataSetIException

hsize_t H5::DataSet::getStorageSize ( ) const

virtual

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

Exceptions

H5::DataSetIException

Implements H5::AbstractDs.

hsize_t H5::DataSet::getVlenBufSize	(	const DataType &	type,
		const DataSpace &	space
	)		const

Parameters

type	- IN: Datatype, which is the datatype for the buffer
space	- IN: Selection for the memory buffer

Returns: Amount of storage

Exceptions

H5::DataSetIException

References H5::DataSpace::getId(), and H5::DataType::getId().

int H5::DataSet::iterateElems	(	void *	buf,
		const DataType &	type,
		const DataSpace &	space,
		H5D_operator_t	op,
		void *	op_data = `NULL`
	)

Parameters

buf	- IN/OUT: Pointer to the buffer in memory containing the elements to iterate over
type	- IN: Datatype for the elements stored in buf
space	- IN: Dataspace for buf. Also contains the selection to iterate over.
op	- IN: Function pointer to the routine to be called for each element in buf iterated over
op_data	- IN/OUT: Pointer to any user-defined data associated with the operation

Exceptions

H5::DataSetIException

Note: This function may not work correctly yet - it's still under development.

References H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::read	(	void *	buf,
		const DataType &	mem_type,
		const DataSpace &	mem_space = `DataSpace::ALL`,
		const DataSpace &	file_space = `DataSpace::ALL`,
		const DSetMemXferPropList &	xfer_plist = `DSetMemXferPropList::DEFAULT`
	)		const

Parameters

buf	- IN: Buffer for read data
mem_type	- IN: Memory datatype
mem_space	- IN: Memory dataspace
file_space	- IN: Dataset's dataspace in the file
xfer_plist	- IN: Transfer property list for this I/O operation

Exceptions

H5::DataSetIException

Description: This function reads raw data from this dataset into the buffer buf, converting from file datatype and dataspace to memory datatype mem_type and dataspace mem_space.

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

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::read	(	H5std_string &	strg,
		const DataType &	mem_type,
		const DataSpace &	mem_space = `DataSpace::ALL`,
		const DataSpace &	file_space = `DataSpace::ALL`,
		const DSetMemXferPropList &	xfer_plist = `DSetMemXferPropList::DEFAULT`
	)		const

Parameters

strg	- IN: Buffer for read data string
mem_type	- IN: Memory datatype
mem_space	- IN: Memory dataspace
file_space	- IN: Dataset's dataspace in the file
xfer_plist	- IN: Transfer property list for this I/O operation

Exceptions

H5::DataSetIException

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::vlenReclaim	(	const DataType &	type,
		const DataSpace &	space,
		const DSetMemXferPropList &	xfer_plist,
		void *	buf
	)

static

Parameters

type	- IN: Datatype, which is the datatype stored in the buffer
space	- IN: Selection for the memory buffer to free the VL datatypes within
xfer_plist	- IN: Property list used to create the buffer
buf	- IN: Pointer to the buffer to be reclaimed

Exceptions

H5::DataSetIException

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::vlenReclaim	(	void *	buf,
		const DataType &	type,
		const DataSpace &	space = `DataSpace::ALL`,
		const DSetMemXferPropList &	xfer_plist = `DSetMemXferPropList::DEFAULT`
	)

static

Parameters

type	- IN: Datatype, which is the datatype stored in the buffer
space	- IN: Selection for the memory buffer to free the VL datatypes within
xfer_plist	- IN: Property list used to create the buffer
buf	- IN: Pointer to the buffer to be reclaimed

Exceptions

H5::DataSetIException

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::write	(	const void *	buf,
		const DataType &	mem_type,
		const DataSpace &	mem_space = `DataSpace::ALL`,
		const DataSpace &	file_space = `DataSpace::ALL`,
		const DSetMemXferPropList &	xfer_plist = `DSetMemXferPropList::DEFAULT`
	)		const

Parameters

buf	- IN: Buffer containing data to be written
mem_type	- IN: Memory datatype
mem_space	- IN: Memory dataspace
file_space	- IN: Dataset's dataspace in the file
xfer_plist	- IN: Transfer property list for this I/O operation

Exceptions

H5::DataSetIException

Description: This function writes raw data from an application buffer buf to a dataset, converting from memory datatype mem_type and dataspace mem_space to file datatype and dataspace.

Examples:: compound.cpp, create.cpp, extend_ds.cpp, and writedata.cpp.

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

void H5::DataSet::write	(	const H5std_string &	buf,
		const DataType &	mem_type,
		const DataSpace &	mem_space = `DataSpace::ALL`,
		const DataSpace &	file_space = `DataSpace::ALL`,
		const DSetMemXferPropList &	xfer_plist = `DSetMemXferPropList::DEFAULT`
	)		const

References H5::PropList::getId(), H5::DataSpace::getId(), and H5::DataType::getId().

Friends And Related Function Documentation

void f_DataSet_setId	(	DataSet *	dset,
		hid_t	new_id
	)

friend

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

H5DataSet.h
H5DataSet.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation