file_imp.hpp

Go to the documentation of this file.

//
// (c) Copyright 2014 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.  See 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: Jul 16, 2014
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//

#pragma once

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

#include "object_imp.hpp"

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

    //forward declaration of group implemenation
    class group_imp;
            
    class file_imp
    {
        private:
            object_imp _object;
        public:
            //===============constructors and destructors======================
            explicit file_imp() noexcept;

            //-----------------------------------------------------------------
            explicit file_imp(object_imp &&o);

            //=====================factory methods=============================
            static file_imp open(const pni::core::string &n,bool ro=true);

            //-----------------------------------------------------------------
            static file_imp create(const pni::core::string &path,bool ow=false,
                                   ssize_t ssize=0);

            //====================misc methods=================================
            void close();

            //-----------------------------------------------------------------
            void flush() const;

            //-----------------------------------------------------------------
            bool is_readonly() const;

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

            //----------------------------------------------------------------
            group_imp root() const;


    };


//end of namespace
}
}
}
}