HighFive::Attribute Class Reference

Class representing an attribute of a dataset or group. More...

#include <H5Attribute.hpp>

Inheritance diagram for HighFive::Attribute:

Collaboration diagram for HighFive::Attribute:

Public Member Functions
std::string	getName () const
	return the name of the current attribute More...
size_t	getStorageSize () const
DataType	getDataType () const
	getDataType More...
DataSpace	getSpace () const
	getSpace More...
DataSpace	getMemSpace () const
	getMemSpace More...
template<typename T >
void	read (T &array) const
template<typename T >
void	read (T *array, const DataType &dtype=DataType()) const
template<typename T >
void	write (const T &buffer)
template<typename T >
void	write_raw (const T *buffer, const DataType &dtype=DataType())
	Attribute ()=delete
Public Member Functions inherited from HighFive::Object
	~Object ()
bool	isValid () const noexcept
	isValid More...
hid_t	getId () const noexcept
	getId More...
ObjectInfo	getInfo () const
	Retrieve several infos about the current object (address, dates, etc) More...
ObjectType	getType () const
	Gets the fundamental type of the object (dataset, group, etc) More...
bool	operator== (const Object &other) const noexcept
Public Member Functions inherited from HighFive::PathTraits< Attribute >
	PathTraits ()
std::string	getPath () const
	return the path to the current object More...
File &	getFile () const noexcept
	Return a reference to the File object this object belongs. More...

Static Public Attributes
static const ObjectType	type = ObjectType::Attribute

Friends
template<typename Derivate >
class	::HighFive::AnnotateTraits

Additional Inherited Members
Protected Member Functions inherited from HighFive::Object
	Object ()
	Object (const Object &other)
	Object (Object &&other) noexcept
	Object (hid_t)
Object &	operator= (const Object &other)
Protected Attributes inherited from HighFive::Object
hid_t	_hid
Protected Attributes inherited from HighFive::PathTraits< Attribute >
std::shared_ptr< File >	_file_obj

Detailed Description

Class representing an attribute of a dataset or group.

Constructor & Destructor Documentation

Attribute()

HighFive::Attribute::Attribute ( )

delete

Member Function Documentation

getDataType()

DataType HighFive::Attribute::getDataType ( ) const

inline

getDataType

Returns

return the datatype associated with this dataset

getMemSpace()

DataSpace HighFive::Attribute::getMemSpace ( ) const

inline

getMemSpace

Returns

same than getSpace for DataSet, compatibility with Selection class

getName()

std::string HighFive::Attribute::getName ( ) const

inline

return the name of the current attribute

Returns

the name of the attribute

getSpace()

DataSpace HighFive::Attribute::getSpace ( ) const

inline

getSpace

Returns

return the dataspace associated with this dataset

getStorageSize()

size_t HighFive::Attribute::getStorageSize ( ) const

inline

read() [1/2]

template<typename T >

void HighFive::Attribute::read ( T &  array ) const

inline

Read the attribute into a buffer An exception is raised if the numbers of dimension of the buffer and of the attribute are different

The array type can be a N-pointer or a N-vector ( e.g int** integer two dimensional array )

read() [2/2]

template<typename T >

void HighFive::Attribute::read ( T *  array, const DataType &  dtype = DataType()  ) const

inline

Read the attribute into a buffer

write()

template<typename T >

void HighFive::Attribute::write ( const T &  buffer )

inline

Write the integrality N-dimension buffer to this attribute An exception is raised if the numbers of dimension of the buffer and of the attribute are different

The array type can be a N-pointer or a N-vector ( e.g int** integer two dimensional array )

write_raw()

template<typename T >

void HighFive::Attribute::write_raw ( const T *  buffer, const DataType &  dtype = DataType()  )

inline

Write a buffer to this attribute

Friends And Related Function Documentation

::HighFive::AnnotateTraits

template<typename Derivate >

friend class ::HighFive::AnnotateTraits

friend

Member Data Documentation

type

const ObjectType HighFive::Attribute::type = ObjectType::Attribute

static

---

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

• /builddir/build/BUILD/HighFive-2.3.1/include/highfive/H5Attribute.hpp
• /builddir/build/BUILD/HighFive-2.3.1/include/highfive/bits/H5Attribute_misc.hpp