compound.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: Oct 5, 2017
//
#pragma once

#include <h5cpp/datatype/datatype.hpp>

namespace hdf5 {
namespace datatype {

class DLL_EXPORT Compound : public Datatype {
 public:
  Compound() = default;

  Compound(ObjectHandle &&handle);

  Compound(const Datatype &type);

  static Compound create(size_t size);

  Datatype operator[](size_t index) const;

  Datatype operator[](const std::string &name) const;

  size_t field_index(const std::string &name) const;

  std::string field_name(size_t index) const;

  size_t field_offset(const std::string &name) const;
  size_t field_offset(size_t index) const;

  Class field_class(const std::string &name) const;
  Class field_class(size_t index) const;

  size_t number_of_fields() const;

  void insert(const std::string &name, size_t offset, const Datatype &type) const;

  void pack() const;

};

} // namespace datatype
} // namespace hdf5