worldsim/include/ownable.h

/********************************************************************************
 *  WorldSim -- library for robot simulations                                   *
 *  Copyright (C) 2008-2011 Gianluca Massera <emmegian@yahoo.it>                *
 *                                                                              *
 *  This program is free software; you can redistribute it and/or modify        *
 *  it under the terms of the GNU General Public License as published by        *
 *  the Free Software Foundation; either version 2 of the License, or           *
 *  (at your option) any later version.                                         *
 *                                                                              *
 *  This program 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 General Public License for more details.                                *
 *                                                                              *
 *  You should have received a copy of the GNU General Public License           *
 *  along with this program; if not, write to the Free Software                 *
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#ifndef OWNABLE_H
#define OWNABLE_H

#include "worldsimconfig.h"
#include <QList>

namespace farsa {

class FARSA_WSIM_API Ownable
{
public:
    struct Owned {
        Owned(Ownable *o, bool d = true) :
            object(o),
            destroy(d)
        {
        }

        bool operator==(const Owned& other)
        {
            return (object == other.object);
        }

        Ownable *object;

        bool destroy;
    };

    typedef QList<Owned> OwnedList;

public:
    Ownable();

    virtual ~Ownable();

    void setOwner(Ownable *owner, bool destroy = true);

    Ownable* owner() const
    {
        return m_owner;
    }

    const QList<Owned>& owned() const
    {
        return m_owned;
    }

private:
    void addToOwned(Ownable *obj, bool destroy);

    void removeFromOwned(Ownable *obj);

    Ownable* m_owner;

    QList<Owned> m_owned;
};

}

#endif