h5dataspace.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 15, 2014
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include "object_imp.hpp"
#include "type_imp.hpp"

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

    //forward declaration of selection
    class selection;

    class h5dataspace
    {
        public:
            typedef type_imp::index_type value_type;
            typedef type_imp::index_vector_type::const_iterator iterator;
        private:
            object_imp _object;
            type_imp::index_vector_type _dims;    
            type_imp::index_vector_type _maxdims; 

            //-----------------------------------------------------------------
            void __init_buffers() noexcept;

            //-----------------------------------------------------------------
            void __update_dataspace();

            //----------------------------------------------------------------
            void __update_buffers();

        public:
            //==============constructors and destructor========================
            explicit h5dataspace();

            //-----------------------------------------------------------------
            h5dataspace(object_imp &&o);

            //-----------------------------------------------------------------
            explicit h5dataspace(const type_imp::index_vector_type &shape);

            //----------------------------------------------------------------
            explicit h5dataspace(type_imp::index_vector_type  &&shape);

            //=====================convenience  methods========================
            size_t rank() const;

            //-----------------------------------------------------------------
            hid_t id() const noexcept;

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

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

            //----------------------------------------------------------------
            bool has_selection() const;

            //----------------------------------------------------------------
            const type_imp::index_vector_type &shape() const noexcept;

            //-----------------------------------------------------------------
            void grow(size_t dim=0,size_t ext=1) ;

            //----------------------------------------------------------------
            void apply_selection(const selection &s) const ;

            //----------------------------------------------------------------
            void reset_selection() const noexcept;

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

        };

        //--------------------------------------------------------------------
        std::ostream &operator<<(std::ostream &o,const h5dataspace &s);

//end of namespace
}
}
}
}