#include <c++/src/H5DataType.h>

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.

Inheritance diagram for DataType:

Public Member Functions
virtual void	close () override

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

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

bool	committed () const

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

void	copy (const DataSet &dset)

void	copy (const DataType &like_type)

	DataType ()

	DataType (const DataType &original)

	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, const PropList &plist=PropList::DEFAULT)

	DataType (const H5T_class_t type_class, size_t size)

	DataType (const hid_t type_id)

	DataType (const PredType &pred_type)

virtual DataType *	decode () const

bool	detectClass (H5T_class_t cls) const

void	encode ()

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

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

H5T_class_t	getClass () const

PropList	getCreatePlist () const

virtual hid_t	getId () const override

size_t	getSize () const

DataType	getSuper () const

H5std_string	getTag () const

bool	hasBinaryDesc () const

bool	isVariableStr () const

void	lock () const

bool	operator!= (const DataType &compared_type) const

DataType &	operator= (const DataType &rhs)

bool	operator== (const DataType &compared_type) 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	setTag (const char *tag) const

void	setTag (const H5std_string &tag) 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

virtual	~DataType () override

Public Member Functions inherited from H5Object
bool	attrExists (const char *name) const

bool	attrExists (const H5std_string &name) const

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

int	getNumAttrs () const

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

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

unsigned	objVersion () const

Attribute	openAttribute (const char *name) const

Attribute	openAttribute (const H5std_string &name) const

Attribute	openAttribute (const unsigned int idx) const

void	removeAttr (const char *name) const

void	removeAttr (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	visit (H5_index_t idx_type, H5_iter_order_t order, visit_operator_t user_op, void *op_data, unsigned int fields)

Public Member Functions inherited from H5Location
H5O_type_t	childObjType (const char *objname) const

H5O_type_t	childObjType (const H5std_string &objname) const

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

unsigned	childObjVersion (const char *objname) const

unsigned	childObjVersion (const H5std_string &objname) 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 char src_name, const Group &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	copyLink (const H5std_string &src_name, const Group &dst, const H5std_string &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

DataSet	createDataSet (const char *name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const

DataSet	createDataSet (const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const

Group	createGroup (const char *name, const LinkCreatPropList &lcpl) const

Group	createGroup (const char *name, size_t size_hint=0) const

Group	createGroup (const H5std_string &name, const LinkCreatPropList &lcpl) const

Group	createGroup (const H5std_string &name, size_t size_hint=0) const

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

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

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

void	flush (H5F_scope_t scope) 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

H5std_string	getFileName () const

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

H5L_info2_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

void	getNativeObjinfo (const char *grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getNativeObjinfo (const char *name, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getNativeObjinfo (const H5std_string &grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getNativeObjinfo (const H5std_string &name, H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getNativeObjinfo (H5O_native_info_t &objinfo, unsigned fields=H5O_NATIVE_INFO_HDR) const

hsize_t	getNumObjs () const

void	getObjinfo (const char *grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getObjinfo (const char *name, bool follow_link, H5G_stat_t &statbuf) const

void	getObjinfo (const char *name, H5G_stat_t &statbuf) const

void	getObjinfo (const char *name, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getObjinfo (const H5std_string &grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getObjinfo (const H5std_string &name, bool follow_link, H5G_stat_t &statbuf) const

void	getObjinfo (const H5std_string &name, H5G_stat_t &statbuf) const

void	getObjinfo (const H5std_string &name, H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	getObjinfo (H5O_info2_t &objinfo, unsigned fields=H5O_INFO_BASIC) const

H5std_string	getObjnameByIdx (hsize_t idx) const

ssize_t	getObjnameByIdx (hsize_t idx, char *name, size_t size) const

ssize_t	getObjnameByIdx (hsize_t idx, H5std_string &name, size_t size) const

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

H5G_obj_t	getObjTypeByIdx (hsize_t idx) const

H5G_obj_t	getObjTypeByIdx (hsize_t idx, char *type_name) const

H5G_obj_t	getObjTypeByIdx (hsize_t idx, H5std_string &type_name) const

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

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

	H5Location ()

int	iterateElems (const char name, int idx, H5G_iterate_t op, void *op_data)

int	iterateElems (const H5std_string &name, int idx, H5G_iterate_t op, void op_data)

void	link (const char curr_name, const Group &new_loc, const char 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 char target_name, const char link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (const H5std_string &curr_name, const Group &new_loc, const H5std_string &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	link (const H5std_string &target_name, const H5std_string &link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	link (H5L_type_t link_type, const char curr_name, const char new_name) const

void	link (H5L_type_t link_type, const H5std_string &curr_name, const H5std_string &new_name) const

void	mount (const char *name, const H5File &child, const PropList &plist) const

void	mount (const H5std_string &name, const H5File &child, const PropList &plist) const

void	move (const char src, const char dst) const

void	move (const H5std_string &src, const H5std_string &dst) 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 char src_name, const Group &dst, const char dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

void	moveLink (const H5std_string &src_name, const Group &dst, const H5std_string &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

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

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

DataSet	openDataSet (const char *name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const

DataSet	openDataSet (const H5std_string &name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const

Group	openGroup (const char *name) const

Group	openGroup (const H5std_string &name) 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 char name, H5R_type_t ref_type=H5R_OBJECT) const

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

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

void	removeComment (const char *name) const

void	removeComment (const H5std_string &name) const

void	setComment (const char *comment) const

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

void	setComment (const H5std_string &comment) const

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

virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
	For subclasses, H5File and Group, to throw appropriate exception.

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	unmount (const char *name) const

void	unmount (const H5std_string &name) const

Public Member Functions inherited from IdComponent
void	decRefCount () const

void	decRefCount (const hid_t obj_id) const

int	getCounter () const

int	getCounter (const hid_t obj_id) const

H5I_type_t	getHDFObjType () const

void	incRefCount () const

void	incRefCount (const hid_t obj_id) const

H5std_string	inMemFunc (const char *func_name) const

IdComponent &	operator= (const IdComponent &rhs)

void	setId (const hid_t new_id)

virtual	~IdComponent ()=default

Static Public Member Functions
static bool	detectClass (const PredType &pred_type, H5T_class_t cls)

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

static hsize_t	getNumMembers (H5I_type_t type)

static bool	isValid (hid_t an_id)

static bool	typeExists (H5I_type_t type)

Protected Member Functions
hid_t	p_decode () const

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

virtual void	p_setId (const hid_t new_id) override

Protected Member Functions inherited from H5Object
	H5Object ()

virtual	~H5Object () override=default

Protected Member Functions inherited from H5Location
hid_t	p_dereference (hid_t loc_id, const void ref, H5R_type_t ref_type, const PropList &plist, 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

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

virtual	~H5Location () override=default

Protected Member Functions inherited from IdComponent
	IdComponent ()

H5std_string	p_get_file_name () const

Protected Attributes
hid_t	id

Friends
void	f_DataType_setId (DataType *dtype, hid_t new_id)

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

Static Protected Attributes inherited from IdComponent
static bool	H5dontAtexit_called

Constructor & Destructor Documentation

◆ DataType() [1/8]

DataType	(	const H5T_class_t	type_class,
		size_t	size )

◆ DataType() [2/8]

DataType ( const DataType & original )

◆ DataType() [3/8]

DataType ( const PredType & pred_type )

◆ DataType() [4/8]

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

◆ DataType() [5/8]

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

◆ DataType() [6/8]

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

◆ DataType() [7/8]

DataType ( const hid_t type_id )

◆ DataType() [8/8]

DataType ( )

◆ ~DataType()

virtual ~DataType ( )

overridevirtual

Member Function Documentation

◆ close()

virtual void close ( )

overridevirtual

Implements IdComponent.

◆ commit() [1/2]

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

◆ commit() [2/2]

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

◆ committed()

bool committed ( ) const

◆ convert()

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

◆ copy() [1/2]

void copy ( const DataSet & dset )

◆ copy() [2/2]

void copy ( const DataType & like_type )

◆ decode()

virtual DataType * decode ( ) const

virtual

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

◆ detectClass() [1/2]

static bool detectClass	(	const PredType &	pred_type,
		H5T_class_t	cls )

static

◆ detectClass() [2/2]

bool detectClass ( H5T_class_t cls ) const

◆ encode()

void encode ( )

◆ find()

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

◆ fromClass()

virtual H5std_string fromClass ( ) const

overridevirtual

Returns this class name.

Reimplemented from IdComponent.

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

◆ getClass()

H5T_class_t getClass ( ) const

◆ getCreatePlist()

PropList getCreatePlist ( ) const

◆ getId()

virtual hid_t getId ( ) const

overridevirtual

Implements H5Object.

◆ getSize()

size_t getSize ( ) const

◆ getSuper()

DataType getSuper ( ) const

◆ getTag()

H5std_string getTag ( ) const

◆ hasBinaryDesc()

bool hasBinaryDesc ( ) const

◆ isVariableStr()

bool isVariableStr ( ) const

◆ lock()

void lock ( ) const

◆ operator!=()

bool operator!= ( const DataType & compared_type ) const

◆ operator=()

DataType & operator= ( const DataType & rhs )

◆ operator==()

bool operator== ( const DataType & compared_type ) const

◆ p_decode()

hid_t p_decode ( ) const

protected

◆ p_opentype()

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

protected

◆ p_setId()

virtual void p_setId ( const hid_t new_id )

overrideprotectedvirtual

Implements H5Object.

◆ registerFunc() [1/2]

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

◆ registerFunc() [2/2]

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

◆ setTag() [1/2]

void setTag ( const char * tag ) const

◆ setTag() [2/2]

void setTag ( const H5std_string & tag ) const

◆ unregister() [1/2]

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

◆ unregister() [2/2]

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

Friends And Related Symbol Documentation

◆ f_DataType_setId

void f_DataType_setId	(	DataType *	dtype,
		hid_t	new_id )

friend

Field Documentation

◆ id

hid_t id

protected

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

c++/src/H5DataType.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ DataType() [1/8]

◆ DataType() [2/8]

◆ DataType() [3/8]

◆ DataType() [4/8]

◆ DataType() [5/8]

◆ DataType() [6/8]

◆ DataType() [7/8]

◆ DataType() [8/8]

◆ ~DataType()

Member Function Documentation

◆ close()

◆ commit() [1/2]

◆ commit() [2/2]

◆ committed()

◆ convert()

◆ copy() [1/2]

◆ copy() [2/2]

◆ decode()

◆ detectClass() [1/2]

◆ detectClass() [2/2]

◆ encode()

◆ find()

◆ fromClass()

◆ getClass()

◆ getCreatePlist()

◆ getId()

◆ getSize()

◆ getSuper()

◆ getTag()

◆ hasBinaryDesc()

◆ isVariableStr()

◆ lock()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ p_decode()

◆ p_opentype()

◆ p_setId()

◆ registerFunc() [1/2]

◆ registerFunc() [2/2]

◆ setTag() [1/2]

◆ setTag() [2/2]

◆ unregister() [1/2]

◆ unregister() [2/2]

Friends And Related Symbol Documentation

◆ f_DataType_setId

Field Documentation

◆ id