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

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

/** @file
    Defines Vobjec
*/

#include <vos/vos/vosdefs.hh>
#include <vos/vutil/refcount.hh>
#include <vos/vutil/log.hh>

#include <deque>
#include <stdexcept>


namespace VOS
{
    class Vobject;

    /** @class ParentChildRelation parentchildrel.hh vos/vos/parentchildrel.hh
        @ingroup libvos

        This class represents the link from a parent to a child,
        describing the entry in the parent's child list.
    */
    class VOS_API ParentChildRelation : public VUtil::RefCounted
    {
    private:
        int position;
        std::string contextual_name;
        Vobject* child;
        Vobject* parent;

        void decPosition() { position--; }
        void incPosition() { position++; }

    public:
        /** Constructor
            @param parent the parent vobject
            @param child the linked-to child vobject
            @param pos the position in the child list
            @param cn the contextual name in the child list
        */
        ParentChildRelation(Vobject* parent, Vobject* child,
                            int pos, const std::string& cn);

        /** Destructor */
        virtual ~ParentChildRelation();

        /** @return position of the child in the parent's child list */
        int getPosition();

        /** @return contextual name describing the link in the parent's child list */
        const std::string& getContextualName();

        /** @return child end of the link */
        VUtil::vRef<Vobject> getChild();

        /** @return parent end of the link */
        VUtil::vRef<Vobject> getParent();

        friend class VobjectState;
    };
}

#endif