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)

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)

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

Deprecated - replaced by H5Object::createAttribute. More...

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

Deprecated - replaced by H5Object::createAttribute. More...

Attribute openAttribute (const char *name) const

Deprecated - replaced by H5Object::openAttribute. More...

Attribute openAttribute (const H5std_string &name) const

Deprecated - replaced by H5Object::openAttribute. More...

Attribute openAttribute (const unsigned int idx) const

Deprecated - replaced by H5Object::openAttribute. More...

bool attrExists (const char *name) const

Deprecated - replaced by H5Object::attrExists() More...

bool attrExists (const H5std_string &name) const

Deprecated - replaced by H5Object::attrExists() More...

void renameAttr (const char *oldname, const char *newname) const

Deprecated - replaced by H5Object::renameAttr() More...

void renameAttr (const H5std_string &oldname, const H5std_string &newname) const

Deprecated - replaced by H5Object::renameAttr() More...

void removeAttr (const char *name) const

Deprecated - replaced by H5Object::removeAttr() More...

void removeAttr (const H5std_string &name) const

Deprecated - replaced by H5Object::removeAttr() More...

int getNumAttrs () const

ssize_t getObjName (char *obj_name, size_t buf_size=0) const

ssize_t getObjName (H5std_string &obj_name, size_t len=0) const

H5std_string getObjName () const

Public Member Functions inherited from H5::H5Location

bool nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Checks if a link of a given name exists in a location. More...

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

void getObjectInfo (H5O_info_t *oinfo) const

Retrieve information about an object, specified by location.

Exceptions

H5::LocationException.

More...

void getObjectInfo (const char *name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Retrieve information about an object, specified by name.

Exceptions

H5::LocationException.

More...

void getObjectInfo (const H5std_string &name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Retrieve information about an object, specified by name.

Exceptions

H5::LocationException.

More...

int getNumAttrs () const

Deprecated - replaced by H5Object::getNumAttrs() 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...

unsigned objVersion () const

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

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

hid_t openObjId (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Opens an object without knowing the object type. More...

hid_t openObjId (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string for the object's path. More...

void closeObjId (hid_t obj_id) const

Closes an object, which was opened with H5Location::openObjId. More...

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

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 bool	isValid (hid_t an_id)
	Checks if the given ID is valid. More...

Friends
void	f_DataSet_setId (DataSet *dset, hid_t new_id)

Additional Inherited Members
Protected Member Functions inherited from H5::H5Location
virtual	~H5Location ()
	Noop destructor. More...

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

Detailed Description

An datasets 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`
	)

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

Exceptions

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation