object_id.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: Martin Shetty <martin.shetty@esss.se>
//          Sebastian Koenig <skoenig@ncsu.edu>
//
#pragma once
 
#include <h5cpp/core/hdf5_capi.hpp>
#include <string>
#include <sstream>
#include <h5cpp/core/filesystem.hpp>
#include <h5cpp/core/windows.hpp>
#include <h5cpp/core/object_handle.hpp>
 
namespace hdf5
{
 
 
class DLL_EXPORT ObjectId
{
  public:
    ObjectId() {}
 
    ObjectId(const ObjectHandle &handle);
 
    bool operator== (const ObjectId& other) const;
 
    bool operator!= (const ObjectId& other) const;
 
    bool operator< (const ObjectId& other) const;
 
#ifndef _DOXYGEN_ /* workaround for the #613 breathe bug */
    DLL_EXPORT friend std::ostream & operator<<(std::ostream &os, const ObjectId& p);
#endif /* DOXYGEN */
 
    unsigned long file_number() const noexcept;
 
    haddr_t object_address() const noexcept;
 
    fs::path file_name() const noexcept;
 
    static std::string get_file_name(const ObjectHandle &handle);
 
#if H5_VERSION_GE(1,11,0)
#define H5O_info_t_ H5O_info1_t
#else
#define H5O_info_t_ H5O_info_t
#endif
 
    static H5O_info_t_ get_info(const ObjectHandle &handle);
 
 
 private:
    unsigned long file_num_ {0};
    haddr_t       obj_addr_ {0};
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    fs::path   file_name_;
#ifdef _MSC_VER
#pragma warning(pop)
#endif
};
 
#ifdef _DOXYGEN_ /* workaround for the #613 breathe bug */
    DLL_EXPORT friend std::ostream & operator<<(std::ostream &os, const ObjectId& p);
#endif /* DOXYGEN */
 
}