Class Attribute operates on HDF5 attributes. More...

#include <H5Attribute.h>

Inheritance diagram for H5::Attribute:

Collaboration diagram for H5::Attribute:

Public Member Functions
	Attribute (const Attribute &original)

	Attribute ()

	Attribute (const hid_t attr_id)

virtual void	close ()

ssize_t	getName (char *attr_name, size_t buf_size=0) const

H5std_string	getName (size_t len) const

H5std_string	getName () const

ssize_t	getName (H5std_string &attr_name, size_t len=0) const

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

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

void	read (const DataType &mem_type, void *buf) const

void	read (const DataType &mem_type, H5std_string &strg) const

void	write (const DataType &mem_type, const void *buf) const

void	write (const DataType &mem_type, const H5std_string &strg) const

void	flush (H5F_scope_t scope) const

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

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

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

virtual	~Attribute ()

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

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
virtual void	p_setId (const hid_t new_id)

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

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

Private Member Functions
virtual hid_t	p_get_type () const

void	p_read_variable_len (const DataType &mem_type, H5std_string &strg) const

void	p_read_fixed_len (const DataType &mem_type, H5std_string &strg) const

int	iterateAttrs ()

void	renameAttr ()

Private Attributes
hid_t	id

Friends
void	f_Attribute_setId (Attribute *attr, 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 Attribute operates on HDF5 attributes.

An attribute has many characteristics similar to a dataset, thus both Attribute and DataSet are derivatives of AbstractDs. Attribute also inherits from IdComponent because an attribute is an HDF5 component that is identified by an identifier.

Definition at line 29 of file H5Attribute.h.

Constructor & Destructor Documentation

◆ Attribute() [1/3]

H5::Attribute::Attribute ( const Attribute & original )

◆ Attribute() [2/3]

H5::Attribute::Attribute ( )

◆ Attribute() [3/3]

H5::Attribute::Attribute ( const hid_t attr_id )

◆ ~Attribute()

virtual H5::Attribute::~Attribute ( )

virtual

Member Function Documentation

◆ close()

virtual void H5::Attribute::close ( )

virtual

Implements H5::IdComponent.

◆ flush()

void H5::Attribute::flush ( H5F_scope_t scope ) const

◆ fromClass()

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

inlinevirtual

Returns this class name.

Implements H5::AbstractDs.

Definition at line 75 of file H5Attribute.h.

◆ getId()

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

virtual

Returns an identifier. (pure virtual)

Implements H5::H5Location.

◆ getInMemDataSize()

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

virtual

Gets the size in memory of this abstract dataset.

Implements H5::AbstractDs.

◆ getName() [1/4]

ssize_t H5::Attribute::getName	(	char *	attr_name,
		size_t	buf_size = `0`
	)		const

◆ getName() [2/4]

H5std_string H5::Attribute::getName ( size_t len ) const

◆ getName() [3/4]

H5std_string H5::Attribute::getName ( ) const

◆ getName() [4/4]

ssize_t H5::Attribute::getName	(	H5std_string &	attr_name,
		size_t	len = `0`
	)		const

◆ getSpace()

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

virtual

Gets the dataspace of this abstract dataset - pure virtual.

Implements H5::AbstractDs.

◆ getStorageSize()

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

virtual

Returns the amount of storage size required - pure virtual.

Implements H5::AbstractDs.

◆ iterateAttrs()

int H5::Attribute::iterateAttrs ( )

inlineprivate

Definition at line 106 of file H5Attribute.h.

◆ p_get_type()

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

privatevirtual

Implements H5::AbstractDs.

◆ p_read_fixed_len()

void H5::Attribute::p_read_fixed_len	(	const DataType &	mem_type,
		H5std_string &	strg
	)		const

private

◆ p_read_variable_len()

void H5::Attribute::p_read_variable_len	(	const DataType &	mem_type,
		H5std_string &	strg
	)		const

private

◆ p_setId()

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

protectedvirtual

Implements H5::H5Location.

◆ read() [1/2]

void H5::Attribute::read	(	const DataType &	mem_type,
		void *	buf
	)		const

◆ read() [2/2]

void H5::Attribute::read	(	const DataType &	mem_type,
		H5std_string &	strg
	)		const

◆ renameAttr()

void H5::Attribute::renameAttr ( )

inlineprivate

Definition at line 109 of file H5Attribute.h.

◆ throwException()

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

virtual

Reimplemented from H5::IdComponent.

◆ write() [1/2]

void H5::Attribute::write	(	const DataType &	mem_type,
		const void *	buf
	)		const

◆ write() [2/2]

void H5::Attribute::write	(	const DataType &	mem_type,
		const H5std_string &	strg
	)		const

Friends And Related Function Documentation

◆ f_Attribute_setId

void f_Attribute_setId	(	Attribute *	attr,
		hid_t	new_id
	)

friend

Field Documentation

◆ id

hid_t H5::Attribute::id

private

Definition at line 93 of file H5Attribute.h.

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

win64/HDF5_1.8.21/include/H5Attribute.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Attribute() [1/3]

◆ Attribute() [2/3]

◆ Attribute() [3/3]

◆ ~Attribute()

Member Function Documentation

◆ close()

◆ flush()

◆ fromClass()

◆ getId()

◆ getInMemDataSize()

◆ getName() [1/4]

◆ getName() [2/4]

◆ getName() [3/4]

◆ getName() [4/4]

◆ getSpace()

◆ getStorageSize()

◆ iterateAttrs()

◆ p_get_type()

◆ p_read_fixed_len()

◆ p_read_variable_len()

◆ p_setId()

◆ read() [1/2]

◆ read() [2/2]

◆ renameAttr()

◆ throwException()

◆ write() [1/2]

◆ write() [2/2]

Friends And Related Function Documentation

◆ f_Attribute_setId

Field Documentation

◆ id