tracks.h

Go to the documentation of this file.

/* Tide
 *
 * Header for the TrackEntry element and related elements.
 *
 * 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_TRACKS_H_)
#define TIDE_TRACKS_H_

#include <boost/operators.hpp>
#include <map>
#include <tide/master_element.h>
#include <tide/track_entry.h>
#include <tide/uint_element.h>
#include <tide/win_dll.h>


namespace tide
{
    class TIDE_EXPORT Tracks : public MasterElement,
            public boost::equality_comparable<Tracks>
    {
        public:
            typedef uint64_t key_type;
            typedef TrackEntry::Ptr mapped_type;

        protected:
            typedef std::map<key_type, mapped_type> storage_type_;

        public:
            Tracks();

            virtual ~Tracks() {};

            typedef storage_type_::value_type value_type;
            typedef storage_type_::size_type size_type;
            typedef storage_type_::reference reference;
            typedef storage_type_::const_reference const_reference;
            typedef storage_type_::iterator iterator;
            typedef storage_type_::const_iterator const_iterator;
            typedef storage_type_::reverse_iterator reverse_iterator;
            typedef storage_type_::const_reverse_iterator
                const_reverse_iterator;

            Tracks& operator=(Tracks const& other)
                { entries_ = other.entries_; return *this; }

            mapped_type& at(key_type const& pos)
                { return entries_.at(pos); }
            mapped_type const& at(key_type const& pos) const
                { return entries_.at(pos); }

            mapped_type& operator[](key_type const& key);
            mapped_type const& operator[](key_type const& key) const;

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

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

            void clear() { entries_.clear(); }
            std::pair<iterator, bool> insert(mapped_type const& value);
            void insert(const_iterator first, const_iterator last);
            void erase(iterator position)
                { entries_.erase(position); }
            void erase(iterator first, iterator last)
                { entries_.erase(first, last); }
            size_type erase(key_type const& number)
                { return entries_.erase(number); }
            void swap(Tracks& other)
                { entries_.swap(other.entries_); }

            iterator find(key_type const& number)
                { return entries_.find(number); }
            const_iterator find(key_type const& number) const
                { return entries_.find(number); }

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

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

        protected:
            storage_type_ entries_;

            virtual std::streamsize body_size() const;

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

            void validate_entries() const;

            void verify_not_duplicate(TrackEntry::Ptr entry) const;
    }; // class Tracks

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

// group elements

#endif // TIDE_TRACKS_H_