field_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

#include <pni/core/types.hpp>


#include "object_imp.hpp"
#include "type_imp.hpp"
#include "h5dataspace.hpp"
#include "h5datatype.hpp"
#include "h5filter.hpp"
#include "attribute_imp.hpp"
#include "selection.hpp"


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

    //forward declarations
    class group_imp;

    class field_imp
    {
        private:
            object_imp _object;
            h5dataspace _file_space;
            selection _selection;
            bool _selection_applied;

            //----------------------------------------------------------------
            void _update();

            //----------------------------------------------------------------
            void _read_data(const h5datatype &memtype,
                           const h5dataspace &memspace,
                           const h5dataspace &filespace,
                           const object_imp &xfer_list,
                           void *ptr) const;

            //----------------------------------------------------------------
            void _write_data(const h5datatype &memtype,
                             const h5dataspace &memspace,
                             const h5dataspace &filespace,
                             const void *ptr) const;

            //-----------------------------------------------------------------
            void _throw_if_not_valid(const pni::core::exception_record &record,
                                     const pni::core::string &message) const
            {
                if(!is_valid())
                    throw invalid_object_error(record,message);
            }

        public:
            //===================Constructors and destructors==================
            explicit field_imp() noexcept;
            
            //-----------------------------------------------------------------
            explicit field_imp(object_imp &&o);

            //-----------------------------------------------------------------
            explicit field_imp(const group_imp &parent,
                               const pni::core::string &name,
                               pni::core::type_id_t tid,
                               const type_imp::index_vector_type &shape,
                               const type_imp::index_vector_type &chunk,
                               const h5filter &filter = h5filter());


            //=================methods to modify the dataset===================
            void grow(const size_t &e=0,const size_t &n=1) ;

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

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

            //-----------------------------------------------------------------
            size_t rank() const;

            //-----------------------------------------------------------------
            pni::core::type_id_t type_id() const ;

            //-----------------------------------------------------------------
            void apply_selection(const type_imp::selection_vector_type &s);

            //----------------------------------------------------------------
            void clear_selections() ;

            //===================reading data methods==========================
            void read(pni::core::type_id_t tid,
                      const type_imp::index_vector_type &shape,
                      void *ptr) const;

            //===============writing data methods==============================
            void write(pni::core::type_id_t tid,
                       const type_imp::index_vector_type &shape,
                       const void *ptr) const;


            //=================================================================
            // DEFAULT OBJECT METHODS
            //=================================================================
            pni::core::string name() const;

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

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

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

            //=================================================================
            //ATTRIBUTE INTERFACE
            //=================================================================

            //----------------------------------------------------------------
            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
}
}
}
}