group_imp.hpp

Go to the documentation of this file.

//
// (c) Copyright 2011 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: Jan 10, 2012
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include <pni/core/types.hpp>

#include "object_imp.hpp"
#include "type_imp.hpp"
#include "hdf5_utilities.hpp"
#include "attribute_utils.hpp"
#include "attribute_imp.hpp"


namespace pni{
namespace io{
namespace nx{
namespace h5{
    
    class group_imp
    {
        private:
            object_imp _object;
        public:
            //==========constructors and destructors===========================
            explicit group_imp() noexcept;

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

            //-----------------------------------------------------------------
            explicit group_imp(const group_imp &parent,
                               const pni::core::string &name);

            //=================methods to open objects==========================
            object_imp at(const pni::core::string &name) const;

            //-----------------------------------------------------------------
            object_imp at(size_t i) const;

            //----------------------------------------------------------------
            const object_imp &object() const noexcept;

            //======================misc methods===============================
            void remove(const pni::core::string &n) const;

            //----------------------------------------------------------------
            void remove(size_t i) const;
            //-----------------------------------------------------------------
            bool has_child(const pni::core::string &name) const;

            //-----------------------------------------------------------------
            size_t size() const;

            //----------------------------------------------------------------
            pni::core::string name() const;

            //---------------------------------------------------------------
            object_imp parent() const;

            //----------------------------------------------------------------
            pni::core::string filename() const;

            //----------------------------------------------------------------
            void close();

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

            //----------------------------------------------------------------
            attribute_imp attr(const pni::core::string &name,
                               pni::core::type_id_t tid,
                               bool overwrite=false) const;

            //----------------------------------------------------------------
            attribute_imp attr(const pni::core::string &name,
                               pni::core::type_id_t tid,
                               const type_imp::index_vector_type &shape,
                               bool overwrite=false) const;

            //----------------------------------------------------------------
            attribute_imp attr(const pni::core::string &name) const;

            //----------------------------------------------------------------
            attribute_imp attr(size_t i) const;

            //----------------------------------------------------------------
            size_t nattr() const;

            //----------------------------------------------------------------
            bool has_attr(const pni::core::string &name) const;

            //----------------------------------------------------------------
            void del_attr(const pni::core::string &name) const;


    };


        
//end of namespace
}
}
}
}