Class DataSet operates on HDF5 datasets. More...

#include <H5DataSet.h>

Inheritance diagram for H5::DataSet:

Collaboration diagram for H5::DataSet:

Public Member Functions
virtual void	close ()

void	extend (const hsize_t *size) const

void	fillMemBuf (const void fill, const DataType &fill_type, void buf, const DataType &buf_type, const DataSpace &space) const

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

DSetCreatPropList	getCreatePlist () const

haddr_t	getOffset () const

virtual DataSpace	getSpace () const
	Gets the dataspace of this abstract dataset - pure virtual. More...

void	getSpaceStatus (H5D_space_status_t &status) const

virtual hsize_t	getStorageSize () const
	Returns the amount of storage size required - pure virtual. More...

virtual size_t	getInMemDataSize () const
	Gets the size in memory of this abstract dataset. More...

hsize_t	getVlenBufSize (const DataType &type, const DataSpace &space) const

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

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

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

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

int	iterateElems (void buf, const DataType &type, const DataSpace &space, H5D_operator_t op, void op_data=NULL)

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

virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const

	DataSet (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

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

	DataSet ()

	DataSet (const DataSet &original)

	DataSet (const hid_t existing_id)

virtual hid_t	getId () const
	Returns an identifier. (pure virtual) More...

virtual	~DataSet ()

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

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

Attribute	openAttribute (const char *name) const

Attribute	openAttribute (const H5std_string &name) const

Attribute	openAttribute (const unsigned int idx) const

int	getNumAttrs () const

bool	attrExists (const char *name) const

bool	attrExists (const H5std_string &name) const

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

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

void	removeAttr (const char *name) const

void	removeAttr (const H5std_string &name) 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

virtual	~H5Object ()

Public Member Functions inherited from H5::H5Location
int	getNumAttrs () const

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

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

void	flush (H5F_scope_t scope) const

H5std_string	getFileName () const

void	getObjectInfo (H5O_info_t *oinfo) const

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

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

H5G_obj_t	getObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const

H5O_type_t	getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const

unsigned	objVersion () const

void	setComment (const char name, const char comment) const

void	setComment (const H5std_string &name, const H5std_string &comment) const

void	setComment (const char *comment) const

void	setComment (const H5std_string &comment) const

ssize_t	getComment (const char name, size_t buf_size, char comment) const

H5std_string	getComment (const char *name, size_t buf_size=0) const

H5std_string	getComment (const H5std_string &name, size_t buf_size=0) const

void	removeComment (const char *name) const

void	removeComment (const H5std_string &name) const

void	reference (void ref, const char name, H5R_type_t ref_type=H5R_OBJECT) const

void	reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const

void	reference (void ref, const char name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

void	reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

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

void	dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

DataSpace	getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const

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

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

void	link (const char target_name, const char link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &target_name, const H5std_string &link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const char curr_name, const H5Location &new_loc, const char new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &curr_name, const H5Location &new_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const char curr_name, const hid_t same_loc, const char new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &curr_name, const hid_t same_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	unlink (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	unlink (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const char src_name, const H5Location &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const char src_name, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const char src_name, const H5Location &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const char src_name, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5L_info_t	getLinkInfo (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5L_info_t	getLinkInfo (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

H5std_string	getLinkval (const char *link_name, size_t size=0) const

H5std_string	getLinkval (const H5std_string &link_name, size_t size=0) const

virtual int	iterateAttrs (attr_operator_t user_op, unsigned idx=NULL, void op_data=NULL)

Public Member Functions inherited from H5::IdComponent
void	incRefCount (const hid_t obj_id) const

void	incRefCount () const

void	decRefCount (const hid_t obj_id) const

void	decRefCount () const

int	getCounter (const hid_t obj_id) const

int	getCounter () const

H5I_type_t	getHDFObjType () const

IdComponent &	operator= (const IdComponent &rhs)

void	setId (const hid_t new_id)

H5std_string	inMemFunc (const char *func_name) const

virtual	~IdComponent ()

Public Member Functions inherited from H5::AbstractDs
DataType	getDataType () const

ArrayType	getArrayType () const

CompType	getCompType () const

EnumType	getEnumType () const

IntType	getIntType () const

FloatType	getFloatType () const

StrType	getStrType () const

VarLenType	getVarLenType () const

H5T_class_t	getTypeClass () const

virtual	~AbstractDs ()

Static Public Member Functions
static void	vlenReclaim (const DataType &type, const DataSpace &space, const DSetMemXferPropList &xfer_plist, void *buf)

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

Static Public Member Functions inherited from H5::H5Location
static void	closeObjId (hid_t obj_id)

Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)

static bool	isValid (hid_t an_id)

Protected Member Functions
virtual void	p_setId (const hid_t new_id)

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

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

	H5Location (const hid_t loc_id)

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 ()

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

H5std_string	p_get_file_name () const

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

Private Member Functions
virtual hid_t	p_get_type () const

void	p_read_fixed_len (const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string &strg) const

void	p_read_variable_len (const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string &strg) const

Private Attributes
hid_t	id

Friends
void	f_DataSet_setId (DataSet *dset, hid_t new_id)

Additional Inherited Members
Static Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)

Static Protected Attributes inherited from H5::IdComponent
static bool	H5dontAtexit_called

Detailed Description

Class DataSet operates on HDF5 datasets.

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.

Definition at line 28 of file H5DataSet.h.

Constructor & Destructor Documentation

◆ DataSet() [1/5]

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

◆ DataSet() [2/5]

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

◆ DataSet() [3/5]

H5::DataSet::DataSet ( )

◆ DataSet() [4/5]

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

◆ DataSet() [5/5]

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

◆ ~DataSet()

virtual H5::DataSet::~DataSet ( )

virtual

Member Function Documentation

◆ close()

virtual void H5::DataSet::close ( )

virtual

Implements H5::IdComponent.

◆ extend()

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

◆ fillMemBuf() [1/2]

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

◆ fillMemBuf() [2/2]

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

◆ fromClass()

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

inlinevirtual

Returns this class name.

Implements H5::AbstractDs.

Definition at line 86 of file H5DataSet.h.

◆ getCreatePlist()

DSetCreatPropList H5::DataSet::getCreatePlist ( ) const

◆ getId()

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

virtual

Returns an identifier. (pure virtual)

Implements H5::H5Location.

◆ getInMemDataSize()

virtual size_t H5::DataSet::getInMemDataSize ( ) const

virtual

Gets the size in memory of this abstract dataset.

Implements H5::AbstractDs.

◆ getOffset()

haddr_t H5::DataSet::getOffset ( ) const

◆ getSpace()

virtual DataSpace H5::DataSet::getSpace ( ) const

virtual

Gets the dataspace of this abstract dataset - pure virtual.

Implements H5::AbstractDs.

◆ getSpaceStatus()

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

◆ getStorageSize()

virtual hsize_t H5::DataSet::getStorageSize ( ) const

virtual

Returns the amount of storage size required - pure virtual.

Implements H5::AbstractDs.

◆ getVlenBufSize()

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

◆ iterateElems()

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

◆ p_get_type()

virtual hid_t H5::DataSet::p_get_type ( ) const

privatevirtual

Implements H5::AbstractDs.

◆ p_read_fixed_len()

void H5::DataSet::p_read_fixed_len	(	const hid_t	mem_type_id,
		const hid_t	mem_space_id,
		const hid_t	file_space_id,
		const hid_t	xfer_plist_id,
		H5std_string &	strg
	)		const

private

◆ p_read_variable_len()

void H5::DataSet::p_read_variable_len	(	const hid_t	mem_type_id,
		const hid_t	mem_space_id,
		const hid_t	file_space_id,
		const hid_t	xfer_plist_id,
		H5std_string &	strg
	)		const

private

◆ p_setId()

virtual void H5::DataSet::p_setId ( const hid_t new_id )

protectedvirtual

Implements H5::H5Location.

◆ read() [1/2]

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

◆ read() [2/2]

void H5::DataSet::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

◆ throwException()

virtual void H5::DataSet::throwException	(	const H5std_string &	func_name,
		const H5std_string &	msg
	)		const

virtual

Reimplemented from H5::IdComponent.

◆ vlenReclaim() [1/2]

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

static

◆ vlenReclaim() [2/2]

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

static

◆ write() [1/2]

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

◆ write() [2/2]

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

Friends And Related Function Documentation

◆ f_DataSet_setId

void f_DataSet_setId	(	DataSet *	dset,
		hid_t	new_id
	)

friend

Field Documentation

◆ id

hid_t H5::DataSet::id

private

Definition at line 117 of file H5DataSet.h.

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

win64/HDF5_1.8.21/include/H5DataSet.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataSet() [1/5]

◆ DataSet() [2/5]

◆ DataSet() [3/5]

◆ DataSet() [4/5]

◆ DataSet() [5/5]

◆ ~DataSet()

Member Function Documentation

◆ close()

◆ extend()

◆ fillMemBuf() [1/2]

◆ fillMemBuf() [2/2]

◆ fromClass()

◆ getCreatePlist()

◆ getId()

◆ getInMemDataSize()

◆ getOffset()

◆ getSpace()

◆ getSpaceStatus()

◆ getStorageSize()

◆ getVlenBufSize()

◆ iterateElems()

◆ p_get_type()

◆ p_read_fixed_len()

◆ p_read_variable_len()

◆ p_setId()

◆ read() [1/2]

◆ read() [2/2]

◆ throwException()

◆ vlenReclaim() [1/2]

◆ vlenReclaim() [2/2]

◆ write() [1/2]

◆ write() [2/2]

Friends And Related Function Documentation

◆ f_DataSet_setId

Field Documentation

◆ id