h5link.hpp

Go to the documentation of this file.

//
// (c) Copyright 2012 DESY, Eugen Wintersberger <eugen.wintersberger@desy.de>
//
// This file is part of libpniio.
//
// libpniio is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// libpniio 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.  ee the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libpniio.  If not, see <http://www.gnu.org/licenses/>.
// ===========================================================================
//
// Created on: Feb 10, 2012
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//

#pragma once

extern "C"{
#include <hdf5.h>
}

#include <pni/core/types.hpp>
#include <pni/core/error.hpp>

#include "../nxlink_type.hpp"
#include "../nxpath/nxpath.hpp"

namespace pni{
namespace io {
namespace nx{
namespace h5{    

    class group_imp;
   
    class h5link
    {
        private:
            static pni::core::string _nx2hdf5path(const nxpath &p);

            //----------------------------------------------------------------
            static void check_if_valid(const group_imp &loc,
                                       const pni::core::exception_record &record,
                                       const pni::core::string &message);

            //----------------------------------------------------------------
            static void check_if_exists(const group_imp &loc,
                                        const pni::core::string &lname,
                                        const pni::core::exception_record
                                        &record,
                                        const pni::core::string &message="");

            //----------------------------------------------------------------
            static void check_if_exists(const group_imp &loc,size_t index,
                                        const pni::core::exception_record
                                        &record,
                                        const pni::core::string &message="");
                                    

            //----------------------------------------------------------------
            static H5L_info_t get_link_info(const group_imp &loc,
                                            const pni::core::string &name);

            //----------------------------------------------------------------
            static H5L_info_t get_link_info(const group_imp &loc,
                                            size_t index);

            //----------------------------------------------------------------
            static auto get_link_value(const group_imp &loc,const
                                       pni::core::string &lname)
                -> pni::core::string;

    
            //----------------------------------------------------------------
            static auto get_external_link_target(const group_imp &loc,
                                                 const pni::core::string &lname)
                -> pni::io::nx::nxpath;

            //----------------------------------------------------------------
            static auto get_soft_link_target(const group_imp &loc,
                                             const pni::core::string &lname)
                -> pni::io::nx::nxpath;
                                            
        public:
            
            static auto link_name(const group_imp &loc,size_t index)
                -> pni::core::string;

            //----------------------------------------------------------------
            static auto link_target(const group_imp &loc,size_t index)
                -> pni::io::nx::nxpath;

            //----------------------------------------------------------------
            static auto link_target(const group_imp &loc,
                                    const pni::core::string &name)
                -> pni::io::nx::nxpath;

            //----------------------------------------------------------------
            static void create_external_link(const nxpath &target,
                                             const group_imp &loc,
                                             const pni::core::string &name);

            //-----------------------------------------------------------------
            static void create_internal_link(const nxpath &target,
                                             const group_imp &loc,
                                             const pni::core::string &name);

            //-----------------------------------------------------------------
            static auto link_type(const group_imp &loc, 
                                  const pni::core::string &name)
                -> pni::io::nx::nxlink_type;

    };
//end of namespace
}
}
}
}