H5PropertyList.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017-2018, Adrien Devresse <adrien.devresse@epfl.ch>
 *                            Juan Hernando <juan.hernando@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 H5PROPERTY_LIST_HPP
#define H5PROPERTY_LIST_HPP

#include "H5Object.hpp"

#include <H5Ppublic.h>

namespace HighFive {

class Properties {
  public:
    enum Type
    {
       FILE_ACCESS,
       DATASET_CREATE,
       DATASET_ACCESS
    };

    ~Properties();

#ifdef H5_USE_CXX11
    Properties(Properties&& other);
    Properties& operator=(Properties&& other);
#endif

    Type getType() const { return _type; }

    hid_t getId() const { return _hid; }

    template <typename Property>
    void add(const Property& property);

  protected:

    // protected constructor
    explicit Properties(Type type);

  private:
#ifdef H5_USE_CXX11
    Properties(const Properties&) = delete;
    Properties& operator=(const Properties&) = delete;
#else
    Properties(const Properties&);
    Properties& operator=(const Properties&);
#endif

    Type _type;
    hid_t _hid;
};

class DataSetCreateProps : public Properties {
public:
  DataSetCreateProps() : Properties(DATASET_CREATE) {}
};

class DataSetAccessProps : public Properties {
public:
  DataSetAccessProps() : Properties(DATASET_ACCESS) {}
};

class Chunking
{
  public:
    Chunking(const std::vector<hsize_t>& dims) : _dims(dims) {}

    Chunking(std::initializer_list<hsize_t> items) : Chunking(std::vector<hsize_t>{items}) {}

    template<typename... Args>
    Chunking(hsize_t item, Args... args) : Chunking(std::vector<hsize_t>{item, static_cast<hsize_t>(args)...}) {}

    const std::vector<hsize_t>& getDimensions() const {return _dims;}

  private:
    friend class Properties;
    void apply(hid_t hid) const;
    const std::vector<hsize_t> _dims;
};

class Deflate
{
  public:
    Deflate(int level) : _level(level) {}

  private:
    friend class Properties;
    void apply(hid_t hid) const;
    const int _level;
};

class Shuffle
{
  public:
    Shuffle() {}

  private:
    friend class Properties;
    void apply(hid_t hid) const;
};

class Caching
{
  public:
    Caching(const size_t numSlots, const size_t cacheSize,
            const double w0 = H5D_CHUNK_CACHE_W0_DEFAULT)
        : _numSlots(numSlots)
        , _cacheSize(cacheSize)
        , _w0(w0)
    {}

  private:
    friend class Properties;
    void apply(hid_t hid) const;
    const unsigned int _numSlots;
    const size_t _cacheSize;
    const double _w0;
};

} // HighFive

#include "bits/H5PropertyList_misc.hpp"

#endif // H5PROPERTY_LIST_HPP