Public Member Functions | Private Member Functions | Friends | List of all members
HighFive::Attribute Class Reference

#include <H5Attribute.hpp>

Inheritance diagram for HighFive::Attribute:
Inheritance graph
[legend]

Public Member Functions

DataType getDataType () const
 getDataType More...
 
DataSpace getMemSpace () const
 getMemSpace More...
 
DataSpace getSpace () const
 getSpace More...
 
size_t getStorageSize () const
 
template<typename T >
void read (T &array) const
 
template<typename T >
void write (const T &buffer)
 
- Public Member Functions inherited from HighFive::Object
hid_t getId () const
 getId More...
 
bool isValid () const
 isValid More...
 
 ~Object ()
 

Private Member Functions

 Attribute ()
 

Friends

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

Additional Inherited Members

- Protected Member Functions inherited from HighFive::Object
 Object ()
 
 Object (const Object &other)
 
Objectoperator= (const Object &other)
 
- Protected Attributes inherited from HighFive::Object
hid_t _hid
 

Detailed Description

Definition at line 23 of file H5Attribute.hpp.

Constructor & Destructor Documentation

◆ Attribute()

HighFive::Attribute::Attribute ( )
inlineprivate

Definition at line 34 of file H5Attribute_misc.hpp.

Member Function Documentation

◆ getDataType()

DataType HighFive::Attribute::getDataType ( ) const
inline

getDataType

Returns
return the datatype associated with this dataset

Definition at line 40 of file H5Attribute_misc.hpp.

◆ getMemSpace()

DataSpace HighFive::Attribute::getMemSpace ( ) const
inline

getMemSpace

Returns
same than getSpace for DataSet, compatibility with Selection class

Definition at line 55 of file H5Attribute_misc.hpp.

◆ getSpace()

DataSpace HighFive::Attribute::getSpace ( ) const
inline

getSpace

Returns
return the dataspace associated with this dataset

Definition at line 46 of file H5Attribute_misc.hpp.

◆ getStorageSize()

size_t HighFive::Attribute::getStorageSize ( ) const
inline

Definition at line 36 of file H5Attribute_misc.hpp.

◆ read()

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 )

Definition at line 58 of file H5Attribute_misc.hpp.

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

Definition at line 93 of file H5Attribute_misc.hpp.

Friends And Related Function Documentation

◆ ::HighFive::AnnotateTraits

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

Definition at line 69 of file H5Attribute.hpp.


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


lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Mon Feb 28 2022 22:46:11