[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/vos/iterator.hh

Go to the documentation of this file.

/*

    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001-2003 Peter Amstutz

    This library 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 of the License, or (at your option) any later version.

    This library 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 this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <http://www.interreality.org>
*/

#ifndef _VOS_ITERATOR_HH_
#define _VOS_ITERATOR_HH_

#include <iostream>
#include <deque>
#include <stdexcept>
#include <vector>

/** @file
    Defines Vobject iterators
*/

namespace VOS
{
    class PCRIterator;
    typedef PCRIterator ChildListIterator;
    typedef PCRIterator ParentSetIterator;
    class StringIterator;
    typedef StringIterator TypeSetIterator;
    class VobjectIterator;
}

#include <vos/vos/parentchildrel.hh>
#include <vos/vos/vobjectstate.hh>
#include <vos/vutil/iterator.hh>

namespace VUtil {
    /** @ingroup libvos
        Specialization to call release on ParentChildRelation objects.
    */
    template<> inline void iteratorReleaseItem(VOS::ParentChildRelation** pcr)
    {
        (*pcr)->release();
    }
}

namespace VOS
{
    class Vobject;

    /** @class PCRIterator iterator.hh vos/vos/iterator.hh
        @ingroup libvos

        Iterator subclass for iterating over pointers to
        the ParentChildRelation class.
    */
    class VOS_API PCRIterator : public VUtil::Iterator<ParentChildRelation*>
    {
    public:
        PCRIterator() : VUtil::Iterator<ParentChildRelation*>() { }
        PCRIterator(const PCRIterator& i) : VUtil::Iterator<ParentChildRelation*>(i) { }
        PCRIterator(const VobjectState::ChildList& children, int start, int end) {

            for(size_type i = start; i <= (unsigned int)end && i < children.size(); i++) {
                if(children[i]) {
                    children[i]->acquire(); // released by: destructor
                    (*items).push_back(children[i]);
                }
            }
        }
        PCRIterator(const VobjectState::ParentSet& parents) {
            items->resize(parents.size());
            int n = 0;
            for(VobjectState::ParentSet::const_iterator i = parents.begin();
                i != parents.end();
                i++)
            {
                (*i)->acquire(); // released by: destructor
                (*items)[n] = *i;
                n++;
            }
        }

        /** @return the current element, or a null vRef<> if the iterator is at
            an invalid position (at the end)
        */
        VUtil::vRef<ParentChildRelation> operator*() {
            if(pos < items->size()) return VUtil::vRef<ParentChildRelation>((*items)[pos], true);
            else return VUtil::vRef<ParentChildRelation>();
        }

        /* @return item at position i.  As a side effect the iterator
           position will be set to i.
           @throw std::out_of_range if i is greater than the number of
           items.
        */
        VUtil::vRef<ParentChildRelation> operator[](size_type i) {
            if(pos >= items->size())
                throw std::out_of_range("index out of bounds in VOS::PCRIterator::operator[]");
            setPos(i);
            return VUtil::vRef<ParentChildRelation>((*items)[pos], true);
        }
    };

    /** @class StringIterator iterator.hh vos/vos/iterator.hh
        @ingroup libvos

        Iterator subclass for iterating over a list of std::string
        objects.
    */
    class StringIterator : public VUtil::Iterator<std::string>
    {
    public:
        StringIterator() : VUtil::Iterator<std::string>() { }
        StringIterator(const StringIterator& tsi) : VUtil::Iterator<std::string>(tsi) { }
        StringIterator(const std::set<std::string>& types) {
            items->resize(types.size());
            int n = 0;
            for(std::set<std::string>::const_iterator i = types.begin(); i != types.end(); i++)
            {
                (*items)[n] = *i;
                n++;
            }
        }
        StringIterator(const std::vector<std::string>& strs) {
            items->resize(strs.size());
            for(size_type i = 0; i < strs.size(); i++)
            {
                (*items)[i] = strs[i];
            }
        }

        /** @return the current element, or an empty string if the
            iterator is at an invalid position (at the end)
        */
        std::string operator*() {
            if(pos < items->size()) return (*items)[pos];
            else return "";
        }

        /* @return item at position i.  As a side effect the iterator
           position will be set to i.
           @throw std::out_of_range if i is greater than the number of
           items.
        */
        std::string operator[](size_type i) {
            if(pos >= items->size())
                throw std::out_of_range("index out of bounds in VOS::StringIterator::operator[]");
            setPos(i);
            return (*items)[pos];
        }
    };

}


#endif