H5DataSet.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017, Adrien Devresse <adrien.devresse@epfl.ch>
 *
 *  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 "H5DataSpace.hpp"
#include "H5DataType.hpp"
#include "H5Object.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Slice_traits.hpp"
#include "bits/H5Path_traits.hpp"
#include "bits/H5_definitions.hpp"
 
namespace HighFive {
 
class DataSet: public Object,
               public SliceTraits<DataSet>,
               public AnnotateTraits<DataSet>,
               public PathTraits<DataSet> {
  public:
    const static ObjectType type = ObjectType::Dataset;
 
    uint64_t getStorageSize() const;
 
    uint64_t getOffset() const;
 
    DataType getDataType() const;
 
    DataSpace getSpace() const;
 
    DataSpace getMemSpace() const;
 
 
    void resize(const std::vector<size_t>& dims);
 
 
    inline std::vector<size_t> getDimensions() const {
        return getSpace().getDimensions();
    }
 
    inline size_t getElementCount() const {
        return getSpace().getElementCount();
    }
 
    DataSetCreateProps getCreatePropertyList() const {
        return details::get_plist<DataSetCreateProps>(*this, H5Dget_create_plist);
    }
 
    DataSetAccessProps getAccessPropertyList() const {
        return details::get_plist<DataSetAccessProps>(*this, H5Dget_access_plist);
    }
 
    H5_DEPRECATED("Default constructor creates unsafe uninitialized objects")
    DataSet() = default;
 
  protected:
    using Object::Object;  // bring DataSet(hid_t)
 
    DataSet(Object&& o) noexcept
        : Object(std::move(o)) {}
 
    friend class Reference;
    template <typename Derivate>
    friend class NodeTraits;
};
 
}  // namespace HighFive