mirror of
https://git.gfz-potsdam.de/naaice/poet.git
synced 2025-12-15 20:38:23 +01:00
115 lines
3.1 KiB
C++
115 lines
3.1 KiB
C++
/*
|
|
* 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 {
|
|
|
|
///
|
|
/// \brief Class representing a dataset.
|
|
///
|
|
class DataSet: public Object,
|
|
public SliceTraits<DataSet>,
|
|
public AnnotateTraits<DataSet>,
|
|
public PathTraits<DataSet> {
|
|
public:
|
|
const static ObjectType type = ObjectType::Dataset;
|
|
|
|
///
|
|
/// \brief getStorageSize
|
|
/// \return returns the amount of storage allocated for a dataset.
|
|
///
|
|
uint64_t getStorageSize() const;
|
|
|
|
///
|
|
/// \brief getOffset
|
|
/// \return returns DataSet address in file
|
|
///
|
|
uint64_t getOffset() const;
|
|
|
|
///
|
|
/// \brief getDataType
|
|
/// \return return the datatype associated with this dataset
|
|
///
|
|
DataType getDataType() const;
|
|
|
|
///
|
|
/// \brief getSpace
|
|
/// \return return the dataspace associated with this dataset
|
|
///
|
|
DataSpace getSpace() const;
|
|
|
|
///
|
|
/// \brief getMemSpace
|
|
/// \return same than getSpace for DataSet, compatibility with Selection
|
|
/// class
|
|
///
|
|
DataSpace getMemSpace() const;
|
|
|
|
|
|
/// \brief Change the size of the dataset
|
|
///
|
|
/// This requires that the dataset was created with chunking, and you would
|
|
/// generally want to have set a larger maxdims setting
|
|
/// \param dims New size of the dataset
|
|
void resize(const std::vector<size_t>& dims);
|
|
|
|
|
|
/// \brief Get the dimensions of the whole DataSet.
|
|
/// This is a shorthand for getSpace().getDimensions()
|
|
/// \return The shape of the current HighFive::DataSet
|
|
///
|
|
inline std::vector<size_t> getDimensions() const {
|
|
return getSpace().getDimensions();
|
|
}
|
|
|
|
/// \brief Get the total number of elements in the current dataset.
|
|
/// E.g. 2x2x2 matrix has size 8.
|
|
/// This is a shorthand for getSpace().getTotalCount()
|
|
/// \return The shape of the current HighFive::DataSet
|
|
///
|
|
inline size_t getElementCount() const {
|
|
return getSpace().getElementCount();
|
|
}
|
|
|
|
/// \brief Get the list of properties for creation of this dataset
|
|
DataSetCreateProps getCreatePropertyList() const {
|
|
return details::get_plist<DataSetCreateProps>(*this, H5Dget_create_plist);
|
|
}
|
|
|
|
/// \brief Get the list of properties for accession of this dataset
|
|
DataSetAccessProps getAccessPropertyList() const {
|
|
return details::get_plist<DataSetAccessProps>(*this, H5Dget_access_plist);
|
|
}
|
|
|
|
DataSet() = default;
|
|
|
|
protected:
|
|
using Object::Object; // bring DataSet(hid_t)
|
|
|
|
explicit DataSet(Object&& o) noexcept
|
|
: Object(std::move(o)) {}
|
|
|
|
friend class Reference;
|
|
template <typename Derivate>
|
|
friend class NodeTraits;
|
|
};
|
|
|
|
} // namespace HighFive
|