Class DataType provides generic operations on HDF5 datatypes. More...

#include <H5DataType.h>

Inheritance diagram for H5::DataType:

Collaboration diagram for H5::DataType:

Public Member Functions
	DataType (const H5T_class_t type_class, size_t size)

	DataType (const DataType &original)

	DataType (const PredType &pred_type)

	DataType (const H5Location &loc, const char *name)

	DataType (const H5Location &loc, const H5std_string &name)

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

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

virtual void	close ()

void	copy (const DataType &like_type)

void	copy (const DataSet &dset)

virtual DataType *	decode () const

void	encode ()

H5T_class_t	getClass () const

void	commit (const H5Location &loc, const char *name)

void	commit (const H5Location &loc, const H5std_string &name)

bool	committed () const

H5T_conv_t	find (const DataType &dest, H5T_cdata_t **pcdata) const

void	convert (const DataType &dest, size_t nelmts, void buf, void background, const PropList &plist=PropList::DEFAULT) const

DataType &	operator= (const DataType &rhs)

bool	operator== (const DataType &compared_type) const

void	lock () const

size_t	getSize () const

DataType	getSuper () const

void	registerFunc (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const

void	registerFunc (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const

void	unregister (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const

void	unregister (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const

void	setTag (const char *tag) const

void	setTag (const H5std_string &tag) const

H5std_string	getTag () const

bool	detectClass (H5T_class_t cls) const

bool	isVariableStr () const

PropList	getCreatePlist () const

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

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

	DataType (const hid_t type_id)

	DataType ()

bool	hasBinaryDesc () const

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

virtual	~DataType ()

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

Protected Member Functions
hid_t	p_decode () const

virtual void	p_setId (const hid_t new_id)

hid_t	p_opentype (const H5Location &loc, const char *dtype_name) const

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 Attributes
hid_t	id

Private Member Functions
void	p_commit (hid_t loc_id, const char *name)

Private Attributes
unsigned char *	encoded_buf

size_t	buf_size

Friends
void	f_DataType_setId (DataType *dtype, hid_t new_id)

Additional Inherited Members
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)

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 DataType provides generic operations on HDF5 datatypes.

DataType inherits from H5Object because a named datatype is an HDF5 object and is a base class of ArrayType, AtomType, CompType, EnumType, and VarLenType.

Definition at line 28 of file H5DataType.h.

Constructor & Destructor Documentation

◆ DataType() [1/9]

H5::DataType::DataType	(	const H5T_class_t	type_class,
		size_t	size
	)

◆ DataType() [2/9]

H5::DataType::DataType ( const DataType & original )

◆ DataType() [3/9]

H5::DataType::DataType ( const PredType & pred_type )

◆ DataType() [4/9]

H5::DataType::DataType	(	const H5Location &	loc,
		const char *	name
	)

◆ DataType() [5/9]

H5::DataType::DataType	(	const H5Location &	loc,
		const H5std_string &	name
	)

◆ DataType() [6/9]

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

◆ DataType() [7/9]

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

◆ DataType() [8/9]

H5::DataType::DataType ( const hid_t type_id )

◆ DataType() [9/9]

H5::DataType::DataType ( )

◆ ~DataType()

virtual H5::DataType::~DataType ( )

virtual

Member Function Documentation

◆ close()

virtual void H5::DataType::close ( )

virtual

Implements H5::IdComponent.

◆ commit() [1/2]

void H5::DataType::commit	(	const H5Location &	loc,
		const char *	name
	)

◆ commit() [2/2]

void H5::DataType::commit	(	const H5Location &	loc,
		const H5std_string &	name
	)

◆ committed()

bool H5::DataType::committed ( ) const

◆ convert()

void H5::DataType::convert	(	const DataType &	dest,
		size_t	nelmts,
		void *	buf,
		void *	background,
		const PropList &	plist = `PropList::DEFAULT`
	)		const

◆ copy() [1/2]

void H5::DataType::copy ( const DataType & like_type )

◆ copy() [2/2]

void H5::DataType::copy ( const DataSet & dset )

◆ decode()

virtual DataType* H5::DataType::decode ( ) const

virtual

Reimplemented in H5::CompType, H5::StrType, H5::EnumType, H5::IntType, H5::ArrayType, H5::VarLenType, and H5::FloatType.

◆ detectClass()

bool H5::DataType::detectClass ( H5T_class_t cls ) const

◆ encode()

void H5::DataType::encode ( )

◆ find()

H5T_conv_t H5::DataType::find	(	const DataType &	dest,
		H5T_cdata_t **	pcdata
	)		const

◆ fromClass()

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

inlinevirtual

Returns this class name.

Reimplemented from H5::IdComponent.

Reimplemented in H5::CompType, H5::EnumType, H5::FloatType, H5::AtomType, H5::StrType, H5::ArrayType, H5::IntType, H5::VarLenType, and H5::PredType.

Definition at line 123 of file H5DataType.h.

◆ getClass()

H5T_class_t H5::DataType::getClass ( ) const

◆ getCreatePlist()

PropList H5::DataType::getCreatePlist ( ) const

◆ getId()

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

virtual

Returns an identifier. (pure virtual)

Implements H5::H5Location.

◆ getSize()

size_t H5::DataType::getSize ( ) const

◆ getSuper()

DataType H5::DataType::getSuper ( ) const

◆ getTag()

H5std_string H5::DataType::getTag ( ) const

◆ hasBinaryDesc()

bool H5::DataType::hasBinaryDesc ( ) const

◆ isVariableStr()

bool H5::DataType::isVariableStr ( ) const

◆ lock()

void H5::DataType::lock ( ) const

◆ operator=()

DataType& H5::DataType::operator= ( const DataType & rhs )

◆ operator==()

bool H5::DataType::operator== ( const DataType & compared_type ) const

◆ p_commit()

void H5::DataType::p_commit	(	hid_t	loc_id,
		const char *	name
	)

private

◆ p_decode()

hid_t H5::DataType::p_decode ( ) const

protected

◆ p_opentype()

hid_t H5::DataType::p_opentype	(	const H5Location &	loc,
		const char *	dtype_name
	)		const

protected

◆ p_setId()

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

protectedvirtual

Implements H5::H5Location.

◆ registerFunc() [1/2]

void H5::DataType::registerFunc	(	H5T_pers_t	pers,
		const char *	name,
		const DataType &	dest,
		H5T_conv_t	func
	)		const

◆ registerFunc() [2/2]

void H5::DataType::registerFunc	(	H5T_pers_t	pers,
		const H5std_string &	name,
		const DataType &	dest,
		H5T_conv_t	func
	)		const

◆ setTag() [1/2]

void H5::DataType::setTag ( const char * tag ) const

◆ setTag() [2/2]

void H5::DataType::setTag ( const H5std_string & tag ) const

◆ throwException()

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

virtual

Reimplemented from H5::IdComponent.

◆ unregister() [1/2]

void H5::DataType::unregister	(	H5T_pers_t	pers,
		const char *	name,
		const DataType &	dest,
		H5T_conv_t	func
	)		const

◆ unregister() [2/2]

void H5::DataType::unregister	(	H5T_pers_t	pers,
		const H5std_string &	name,
		const DataType &	dest,
		H5T_conv_t	func
	)		const

Friends And Related Function Documentation

◆ f_DataType_setId

void f_DataType_setId	(	DataType *	dtype,
		hid_t	new_id
	)

friend

Field Documentation

◆ buf_size

size_t H5::DataType::buf_size

private

Definition at line 162 of file H5DataType.h.

◆ encoded_buf

unsigned char* H5::DataType::encoded_buf

private

Definition at line 161 of file H5DataType.h.

◆ id

hid_t H5::DataType::id

protected

Definition at line 145 of file H5DataType.h.

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

win64/HDF5_1.8.21/include/H5DataType.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataType() [1/9]

◆ DataType() [2/9]

◆ DataType() [3/9]

◆ DataType() [4/9]

◆ DataType() [5/9]

◆ DataType() [6/9]

◆ DataType() [7/9]

◆ DataType() [8/9]

◆ DataType() [9/9]

◆ ~DataType()

Member Function Documentation

◆ close()

◆ commit() [1/2]

◆ commit() [2/2]

◆ committed()

◆ convert()

◆ copy() [1/2]

◆ copy() [2/2]

◆ decode()

◆ detectClass()

◆ encode()

◆ find()

◆ fromClass()

◆ getClass()

◆ getCreatePlist()

◆ getId()

◆ getSize()

◆ getSuper()

◆ getTag()

◆ hasBinaryDesc()

◆ isVariableStr()

◆ lock()

◆ operator=()

◆ operator==()

◆ p_commit()

◆ p_decode()

◆ p_opentype()

◆ p_setId()

◆ registerFunc() [1/2]

◆ registerFunc() [2/2]

◆ setTag() [1/2]

◆ setTag() [2/2]

◆ throwException()

◆ unregister() [1/2]

◆ unregister() [2/2]

Friends And Related Function Documentation

◆ f_DataType_setId

Field Documentation

◆ buf_size

◆ encoded_buf

◆ id