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

/home/tetron/hack/vos/libs/vos/vos/vobjectstate.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 _VOBJECTSTATE_HH_
#define _VOBJECTSTATE_HH_

/** @file
    Defines VobjectState.
*/

#include <deque>
#include <stdexcept>
#include <boost/thread/recursive_mutex.hpp>

#include <vos/vutil/refcount.hh>
#include <vos/vutil/url.hh>
#include <vos/vutil/log.hh>
#include <vos/vos/listener.hh>
#include <vos/vos/parentchildrel.hh>


namespace VOS
{
    class Site;
    class Message;
    class MessageBlock;
    class TypeChangeListener;
    class ParentChangeListener;
    class ChildChangeListener;
    class ParentChildRelation;
    class VobjectBase;
    class VobjectEvent;

    class PCRIterator;
    typedef PCRIterator ChildListIterator;
    typedef PCRIterator ParentSetIterator;
    class StringIterator;
    typedef StringIterator TypeSetIterator;

/** @class VobjectState vobjectstate.hh vos/vos/vobjectstate.hh
    @ingroup libvos

    This holds the actual state common to every Vobject: the type set,
    the child list, and the parent set.  Listeners are also stored
    here, although the methods of this class do not actually trigger
    the listener callbacks.  The API for VobjectState is basically a
    subset of Vobject, for obvious reasons.  You shouldn't ever access
    a Vobject's state object state directly unless you have a very
    good reason to bypass the extensions, access control checks and
    listener callbacks that are implemented by VobjectBase.
*/
class VOS_API VobjectState
{
public:
    typedef std::set<ParentChildRelation*> ParentSet;
    typedef std::deque<ParentChildRelation*> ChildList;
    typedef std::set<std::string> TypeSet;
private:
    VobjectBase* myvobject;

    ParentSet parents;

    ChildList children;
    std::map<std::string, ParentChildRelation*> children_map;

    TypeSet types;

    void adjustChildMap(ParentChildRelation* pcr, int ofs);
public:
    boost::recursive_mutex state_mutex;

    VUtil::ListenerBase<TypeChangeListener, VobjectEvent> typeListeners;
    VUtil::ListenerBase<ParentChangeListener, VobjectEvent> parentListeners;
    VUtil::ListenerBase<ChildChangeListener, VobjectEvent> childListeners;

    VobjectState(VobjectBase* myvobject);
    ~VobjectState();

    VUtil::vRef<VobjectBase> getBase();

    void addType(const std::string& s);
    void removeType(const std::string& s);
    TypeSetIterator getTypes();

    int numChildren();
    void insertChild(int pos, const std::string& c, Vobject* vobj);
    void setChild(int pos, const std::string& c, Vobject* vobj);
    void removeChild(int pos);
    void fixPosition(int& pos, int forinsert = 0);

    bool hasChild(const std::string& c);
    bool hasChild(int pos);

    VUtil::vRef<ParentChildRelation> findChild(int pos);
    VUtil::vRef<ParentChildRelation> findChild(const std::string& c);
    ChildListIterator getChildren(int start = 0, int end = -1);
    void clearChildren();

    ParentSetIterator getParents();
    VUtil::vRef<ParentChildRelation> findParent(Vobject& parent);
    VUtil::vRef<ParentChildRelation> findParent(Vobject* parent);
    void addParent(ParentChildRelation* pcr);
    void removeParent(ParentChildRelation* pcr);
};
}

#endif