hyperslab.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5cpp.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the
// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
// Boston, MA  02110-1301 USA
// ===========================================================================
//
// Authors:
//   Eugen Wintersberger <eugen.wintersberger@desy.de>
//   Martin Shetty <martin.shetty@esss.se>
// Created on: Aug 25, 2017
//
#pragma once
 
#include <h5cpp/dataspace/selection.hpp>
#include <h5cpp/core/types.hpp>
#include <h5cpp/core/windows.hpp>
#include <memory>
#include <list>
#include <sstream>
 
namespace hdf5 {
namespace dataspace {
 
class DLL_EXPORT Hyperslab : public Selection {
 public:
  Hyperslab();
 
  ~Hyperslab() override;
 
  Hyperslab(const Hyperslab &) = default;
 
  Hyperslab(size_t rank);
 
  Hyperslab(const Dimensions &offset,
            const Dimensions &block,
            const Dimensions &count,
            const Dimensions &stride);
 
  Hyperslab(const Dimensions &offset,
            const Dimensions &block);
 
  //1
  Hyperslab(const Dimensions &offset,
            const Dimensions &count,
            const Dimensions &stride);
 
  size_t rank() const noexcept;
 
  void offset(size_t index, size_t value);
 
  void offset(const Dimensions &values);
 
  const Dimensions &offset() const;
 
  void stride(size_t index, size_t value);
 
  void stride(const Dimensions &values);
 
  const Dimensions &stride() const;
 
  void count(size_t index, size_t value);
 
  void count(const Dimensions &values);
 
  const Dimensions &count() const;
 
  //1
  void block(size_t index, size_t value);
 
  void block(const Dimensions &values);
 
  const Dimensions &block() const;
 
  virtual void apply(const Dataspace &space,
                     SelectionOperation ops) const override;
 
  virtual Dimensions dimensions() const override;
 
  virtual size_t size() const override;
 
  virtual SelectionType type() const override;
 
 private:
  inline void check_dimension_index(size_t index, const std::string &what) const {
    if (index >= rank()) {
      std::stringstream ss;
      ss << "Cannot set " << what << " value at dimension " << index << " for a Hyperslab"
         << " of rank " << rank() << "!";
      throw std::runtime_error(ss.str());
    }
  }
 
  inline void check_container_size(const Dimensions &container, const std::string &what) const {
    if (container.size() != rank()) {
      std::stringstream ss;
      ss << "Cannot assign " << container.size() << " " << what << " values to a Hyperslab"
         << " of rank " << rank() << "!";
      throw std::runtime_error(ss.str());
    }
  }
 
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4251)
#endif
  Dimensions start_;
  Dimensions stride_;
  Dimensions count_;
  Dimensions block_;
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
};
 
DLL_EXPORT Dataspace operator||(const Dataspace &space, const Hyperslab &selection);
 
DLL_EXPORT SelectionList operator|(const Hyperslab &a, const Hyperslab &b);
 
DLL_EXPORT SelectionList &operator|(SelectionList &selections, const Hyperslab &b);
 
} // namespace dataspace
} // namespace hdf5