HighFive::AnnotateTraits< Derivate > Class Template Reference

#include <H5Annotate_traits.hpp>

Public Member Functions
Attribute	createAttribute (const std::string &attribute_name, const DataSpace &space, const DataType &type)
	create a new attribute with the name attribute_name More...
template<typename Type >
Attribute	createAttribute (const std::string &attribute_name, const DataSpace &space)
	createAttribute create a new attribute on the current dataset with size specified by space More...
template<typename T >
Attribute	createAttribute (const std::string &attribute_name, const T &data)
	createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data. More...
Attribute	getAttribute (const std::string &attribute_name) const
	open an existing attribute with the name attribute_name More...
size_t	getNumberAttributes () const
	return the number of attributes of the node / group More...
bool	hasAttribute (const std::string &attr_name) const
	checks an attribute exists More...
std::vector< std::string >	listAttributeNames () const
	list all attribute name of the node / group More...

Private Types
typedef Derivate	derivate_type

Detailed Description

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

Definition at line 23 of file H5Annotate_traits.hpp.

Member Typedef Documentation

derivate_type

template<typename Derivate>

typedef Derivate HighFive::AnnotateTraits< Derivate >::derivate_type

private

Definition at line 82 of file H5Annotate_traits.hpp.

Member Function Documentation

createAttribute() [1/3]

template<typename Derivate >

Attribute HighFive::AnnotateTraits< Derivate >::createAttribute ( const std::string &  attribute_name, const DataSpace &  space, const DataType &  type  )

inline

create a new attribute with the name attribute_name

Parameters

attribute_name

Returns

the attribute object

Definition at line 29 of file H5Annotate_traits_misc.hpp.

createAttribute() [2/3]

template<typename Derivate >

template<typename Type >

Attribute HighFive::AnnotateTraits< Derivate >::createAttribute ( const std::string &  attribute_name, const DataSpace &  space  )

inline

createAttribute create a new attribute on the current dataset with size specified by space

Parameters

dataset_name	identifier of the attribute
space	Associated DataSpace, see DataSpace for more informations

Returns

Attribute Object

Definition at line 46 of file H5Annotate_traits_misc.hpp.

createAttribute() [3/3]

template<typename Derivate >

template<typename T >

Attribute HighFive::AnnotateTraits< Derivate >::createAttribute ( const std::string &  attribute_name, const T &  data  )

inline

createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data.

Parameters

attribute_name	identifier of the attribute
data	Associated data to write, must support DataSpace::From, see DataSpace for more information

Returns

Attribute Object

Definition at line 54 of file H5Annotate_traits_misc.hpp.

getAttribute()

template<typename Derivate >

Attribute HighFive::AnnotateTraits< Derivate >::getAttribute ( const std::string &  attribute_name ) const

inline

open an existing attribute with the name attribute_name

Parameters

attribute_name

Returns

the attribute object

Definition at line 64 of file H5Annotate_traits_misc.hpp.

getNumberAttributes()

template<typename Derivate >

size_t HighFive::AnnotateTraits< Derivate >::getNumberAttributes ( ) const

inline

return the number of attributes of the node / group

Returns

number of attributes

Definition at line 77 of file H5Annotate_traits_misc.hpp.

hasAttribute()

template<typename Derivate >

bool HighFive::AnnotateTraits< Derivate >::hasAttribute ( const std::string &  attr_name ) const

inline

checks an attribute exists

Returns

number of attributes

Definition at line 109 of file H5Annotate_traits_misc.hpp.

listAttributeNames()

template<typename Derivate >

std::vector< std::string > HighFive::AnnotateTraits< Derivate >::listAttributeNames ( ) const

inline

list all attribute name of the node / group

Returns

number of attributes

Definition at line 88 of file H5Annotate_traits_misc.hpp.

---

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

• H5Annotate_traits.hpp
• H5Annotate_traits_misc.hpp