block_additions.h

Go to the documentation of this file.

/* Tide
 *
 * Header file for the BlockAdditions element.
 *
 * Copyright 2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * This file is part of Tide.
 *
 * Tide is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * Tide 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tide. If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined(TIDE_BLOCK_ADDITIONS_H_)
#define TIDE_BLOCK_ADDITIONS_H_

#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include <stdint.h>
#include <tide/master_element.h>
#include <vector>
#include <tide/win_dll.h>


namespace tide
{
    class TIDE_EXPORT BlockAdditions : public MasterElement,
        public boost::equality_comparable<BlockAdditions>
    {
        public:
            typedef std::pair<uint64_t, std::vector<char> > Addition;
            typedef boost::shared_ptr<Addition> AdditionPtr;
            typedef std::vector<AdditionPtr>::value_type value_type;
            typedef std::vector<AdditionPtr>::size_type size_type;
            typedef std::vector<AdditionPtr>::reference reference;
            typedef std::vector<AdditionPtr>::const_reference const_reference;
            typedef std::vector<AdditionPtr>::iterator iterator;
            typedef std::vector<AdditionPtr>::const_iterator const_iterator;
            typedef std::vector<AdditionPtr>::reverse_iterator reverse_iterator;
            typedef std::vector<AdditionPtr>::const_reverse_iterator
                const_reverse_iterator;

            BlockAdditions();

            value_type& at(size_type pos)
                { return additions_.at(pos); }
            value_type const& at(size_type pos) const
                { return additions_.at(pos); }

            value_type& operator[](size_type pos)
                { return additions_[pos]; }
            value_type const& operator[](size_type pos) const
                { return additions_[pos]; }

            iterator begin() { return additions_.begin(); }
            const_iterator begin() const { return additions_.begin(); }
            iterator end() { return additions_.end(); }
            const_iterator end() const { return additions_.end(); }
            reverse_iterator rbegin() { return additions_.rbegin(); }
            const_reverse_iterator rbegin() const
                { return additions_.rbegin(); }
            reverse_iterator rend() { return additions_.rend(); }
            const_reverse_iterator rend() const { return additions_.rend(); }

            bool empty() const { return additions_.empty(); }
            size_type count() const { return additions_.size(); }
            size_type max_count() const { return additions_.max_size(); }

            void clear() { additions_.clear(); }

            void erase(iterator position)
                { additions_.erase(position); }
            void erase(iterator first, iterator last)
                { additions_.erase(first, last); }

            void push_back(value_type const& value);

            void resize(size_type count)
                { additions_.resize(count); }

            void swap(BlockAdditions& other)
                { additions_.swap(other.additions_); }

            friend bool operator==(BlockAdditions const& lhs,
                    BlockAdditions const& rhs);

        protected:
            std::vector<AdditionPtr> additions_;

            virtual std::streamsize body_size() const;

            virtual std::streamsize write_body(std::ostream& output);

            virtual std::streamsize read_body(std::istream& input,
                    std::streamsize size);

            std::streamsize read_addition(std::istream& input,
                    std::streamsize size);
    }; // class BlockAdditions

    bool operator==(BlockAdditions const& lhs, BlockAdditions const& rhs);
}; // namespace tide

// group elements

#endif // TIDE_BLOCK_ADDITIONS_H_