object_handle.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5pp.
//
// 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 07, 2017
//

#pragma once

#include <h5cpp/core/hdf5_capi.hpp>
#include <iostream>

#include <h5cpp/core/windows.hpp>

namespace hdf5
{

class DLL_EXPORT ObjectHandle
{
  public:
    enum class Type
    {
      UNINITIALIZED,
      BADOBJECT,
      FILE,
      GROUP,
      DATATYPE,
      DATASPACE,
      DATASET,
      ATTRIBUTE,
      PROPERTY_LIST,
      VIRTUAL_FILE_LAYER,
      PROPERTY_LIST_CLASS,
      ERROR_CLASS,
      ERROR_MESSAGE,
      ERROR_STACK
    };

    enum class Policy
    {
      WITH_WARD = 1,
      WITHOUT_WARD = 2
    };
  private:
    hid_t handle_; 

    //------------------------------------------------------------------------
    void increment_reference_count() const;

    //------------------------------------------------------------------------
    void decrement_reference_count() const;
  public:
    //================constructors and destructors=====================

    explicit ObjectHandle(hid_t id, Policy policy=Policy::WITH_WARD);

    //-----------------------------------------------------------------
    explicit ObjectHandle() noexcept;

    //-----------------------------------------------------------------
    ObjectHandle(const ObjectHandle &o);

    //-----------------------------------------------------------------
    ObjectHandle(ObjectHandle &&o) noexcept;

    //-----------------------------------------------------------------
    ~ObjectHandle() noexcept;

    //================assignment operators=============================
    ObjectHandle &operator=(const ObjectHandle &o);

    //-----------------------------------------------------------------
    ObjectHandle &operator=(ObjectHandle &&o) noexcept;


    explicit operator hid_t() const
    {
      return handle_;
    }

    //=====================static member functions ====================
    void close();

    //------------------------------------------------------------------
    bool is_valid() const;

    //------------------------------------------------------------------------
    ObjectHandle::Type get_type() const;



    //------------------------------------------------------------------------
    int get_reference_count() const;
};


DLL_EXPORT bool operator==(const ObjectHandle &lhs,const ObjectHandle &rhs);

DLL_EXPORT bool operator!=(const ObjectHandle &lhs,const ObjectHandle &rhs);

DLL_EXPORT std::ostream &operator<<(std::ostream &stream,
                                    const ObjectHandle::Type &type);

} // namespace hdf5