H5DataSet.hpp

/*
 *  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)
 *
 */
#ifndef H5DATASET_HPP
#define H5DATASET_HPP
 
#include <vector>
 
#include "H5DataSpace.hpp"
#include "H5DataType.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Slice_traits.hpp"
#include "bits/H5_definitions.hpp"
 
namespace h5gt {
 
class DataSet : public Object,
    public SliceTraits<DataSet>,
    public AnnotateTraits<DataSet> {
public:
 
  const static ObjectType type = ObjectType::Dataset;
 
  uint64_t getStorageSize() const;
 
  uint64_t getOffset() const;
 
  DataType getDataType() const;
 
  LinkInfo getLinkInfo() const;
 
  DataSpace getSpace() const;
 
  DataSpace getMemSpace() const;
 
  File getFile() const;
 
  std::string unpackSoftLink() const;
 
  void unlink() const;
 
  bool rename(const std::string& dest_path,
              const LinkCreateProps& linkCreateProps = LinkCreateProps(),
              const LinkAccessProps& linkAccessProps = LinkAccessProps()) const;
 
  Group getParent(const GroupAccessProps& groupAccessProps = GroupAccessProps()) const;
 
  DataSetCreateProps getCreateProps() const;
  DataSetAccessProps getAccessProps() 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();
  }
 
  bool operator==(const DataSet& other) const;
  bool operator!=(const DataSet& other) const;
 
  static DataSet FromId(const hid_t& id, const bool& increaseRefCount = false){
      Object obj = Object(id, ObjectType::Dataset, increaseRefCount);
      return DataSet(obj);
  };
 
protected:
  DataSet(const Object& obj) : Object(obj){};
  using Object::Object;
 
  inline DataSet(Object&& o) noexcept : Object(std::move(o)) {}
 
  friend class Reference;
  friend class Selection;
  template <typename Derivate> friend class NodeTraits;
 
};
 
}  // namespace h5gt
 
#endif // H5DATASET_HPP