HDF5Attribute.h

// Copyright (C) 2013 Chris N. Richardson
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// First added:  2013-10-16
// Last changed: 2014-11-24

#ifndef __DOLFIN_HDF5ATTRIBUTE_H
#define __DOLFIN_HDF5ATTRIBUTE_H

#ifdef HAS_HDF5

#include <string>
#include <vector>

#include<dolfin/common/Array.h>
#include "HDF5Interface.h"

namespace dolfin
{


  class HDF5Attribute
  {
  public:

    // FIXME: Check validity of file and dataset

    HDF5Attribute(const hid_t hdf5_file_id, std::string dataset_name)
      : hdf5_file_id(hdf5_file_id), dataset_name(dataset_name) {}

    ~HDF5Attribute() {}

    bool exists(const std::string attribute_name) const;

    void set(const std::string attribute_name, const double value);

    void set(const std::string attribute_name, const std::size_t value);

    void set(const std::string attribute_name,
             const std::vector<double>& value);

    void set(const std::string attribute_name,
             const std::vector<std::size_t>& value);

    void set(const std::string attribute_name, const std::string value);

    void get(const std::string attribute_name, double& value) const;

    void get(const std::string attribute_name,
             std::vector<double>& value) const;

    void get(const std::string attribute_name, std::size_t& value) const;

    void get(const std::string attribute_name,
             std::vector<std::size_t>& value) const;

    void get(const std::string attribute_name, std::string& value) const;

    const std::string str(const std::string attribute_name) const;

    const std::string type_str(const std::string attribute_name) const;

    const std::string str() const;

    const std::vector<std::string> list_attributes() const;

  private:

    const hid_t hdf5_file_id;
    const std::string dataset_name;

    // Set the value of an attribute in the HDF5 file
    template <typename T>
    void set_value(const std::string attribute_name, const T& value);

    // Get the value of an attribute in the HDF5 file
    template <typename T>
    void get_value(const std::string attribute_name, T& value) const;

    template <typename T>
    const std::string
      vector_to_string(const std::vector<T>& vector_value) const;

  };
}

#endif
#endif