nxpath/nxpath.hpp

Go to the documentation of this file.

//
// (c) Copyright 2013 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: Feb 11, 2013
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include <utility>
#include <pni/core/types.hpp>
#include <list>

namespace pni{
namespace io{
namespace nx{
        
    class nxpath
    {
        public: 
            typedef std::pair<pni::core::string,pni::core::string> element_type;
            typedef std::list<element_type> elements_type;
            typedef elements_type::iterator iterator;
            typedef elements_type::const_iterator const_iterator;

        private:
            pni::core::string _file_name;
            pni::core::string _attribute_name;
            elements_type _elements;

        public:
            //===============constructors and destructor=======================
            nxpath();
            //-----------------------------------------------------------------
            explicit nxpath(const pni::core::string &file,
                            const elements_type &groups,
                            const pni::core::string &attr);
           
            //-----------------------------------------------------------------
            static nxpath from_string(const pni::core::string &input);

            //-----------------------------------------------------------------
            static pni::core::string to_string(const nxpath &p);
           
            //===============public member methods=============================
            bool has_filename() const noexcept;

            //-----------------------------------------------------------------
            bool has_attribute() const noexcept;

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

            //----------------------------------------------------------------
            void filename(const pni::core::string &f);

            //-----------------------------------------------------------------
            pni::core::string attribute() const noexcept;

            //----------------------------------------------------------------
            void attribute(const pni::core::string &a);

            //-----------------------------------------------------------------
            void push_back(const element_type &o);

            //----------------------------------------------------------------
            void push_front(const element_type &o);

            //----------------------------------------------------------------
            void pop_front();

            //----------------------------------------------------------------
            void pop_back();

            //-----------------------------------------------------------------
            element_type front() const 
            { 
                return _elements.front(); 
            }

            //----------------------------------------------------------------
            element_type back() const;

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

            //===================iterators======================================
            iterator begin();

            //----------------------------------------------------------------
            iterator end();

            //----------------------------------------------------------------
            const_iterator begin() const;

            //----------------------------------------------------------------
            const_iterator end() const;
    };


//end of namespace
}
}
}