H5Attribute.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017, Ali Can Demiralp <ali.demiralp@rwth-aachen.de>
 *
 *  Distributed under the Boost Software License, Version 1.0.
 *    (See accompanying file LICENSE_1_0.txt or copy at
 *          http://www.boost.org/LICENSE_1_0.txt)
 *
 */
#pragma once
 
#include <vector>
 
#include <H5Apublic.h>
 
#include "H5DataType.hpp"
#include "H5DataSpace.hpp"
#include "H5Object.hpp"
#include "bits/H5Friends.hpp"
#include "bits/H5Path_traits.hpp"
 
namespace HighFive {
class DataSpace;
 
namespace detail {
 
Attribute make_attribute(hid_t hid);
}  // namespace detail
 
class Attribute: public Object, public PathTraits<Attribute> {
  public:
    const static ObjectType type = ObjectType::Attribute;
 
    std::string getName() const;
 
    size_t getStorageSize() const;
 
    DataType getDataType() const;
 
    DataSpace getSpace() const;
 
    DataSpace getMemSpace() const;
 
    template <typename T>
    T read() const;
 
    template <typename T>
    void read(T& array) const;
 
    template <typename T>
    void read_raw(T* array, const DataType& mem_datatype) const;
 
    template <typename T>
    void read_raw(T* array) const;
 
    template <typename T>
    void write(const T& value);
 
    template <typename T>
    void write_raw(const T* buffer, const DataType& mem_datatype);
 
    template <typename T>
    void write_raw(const T* buffer);
 
    AttributeCreateProps getCreatePropertyList() const {
        return details::get_plist<AttributeCreateProps>(*this, H5Aget_create_plist);
    }
 
    // No empty attributes
    Attribute() = delete;
 
    Attribute squeezeMemSpace(const std::vector<size_t>& axes) const;
 
    Attribute reshapeMemSpace(const std::vector<size_t>& dims) const;
 
  protected:
    using Object::Object;
 
  private:
    DataSpace _mem_space;
 
#if HIGHFIVE_HAS_FRIEND_DECLARATIONS
    template <typename Derivate>
    friend class ::HighFive::AnnotateTraits;
#endif
 
    friend Attribute detail::make_attribute(hid_t);
};
 
namespace detail {
inline Attribute make_attribute(hid_t hid) {
    return Attribute(hid);
}
}  // namespace detail
 
}  // namespace HighFive