GObject.h

/***************************************************************************
 *   Copyright (C) 2004 by Raphael Langerhorst                             *
 *   raphael-langerhorst@gmx.at                                            *
 *                                                                         *
 *   Permission is hereby granted, free of charge, to any person obtaining *
 *   a copy of this software and associated documentation files (the       *
 *   "Software"), to deal in the Software without restriction, including   *
 *   without limitation the rights to use, copy, modify, merge, publish,   *
 *   distribute, sublicense, and/or sell copies of the Software, and to    *
 *   permit persons to whom the Software is furnished to do so, subject to *
 *   the following conditions:                                             *
 *                                                                         *
 *   The above copyright notice and this permission notice shall be        *
 *   included in all copies or substantial portions of the Software.       *
 *                                                                         *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       *
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    *
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR     *
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
 *   OTHER DEALINGS IN THE SOFTWARE.                                       *
 ***************************************************************************/

#ifndef GOBJECTH
#define GOBJECTH

#include "GEnergy.h"
#include "GForm.h"
#include "GElementID.h"

#include <qvaluelist.h>
#include <qmutex.h>

namespace GCS
{

class GObject : public QMutex
{
  private:
    GEnergy* Energy;
    
    GForm* Form;
        
    GElementID Parent;
    
    const GElementID ID;
    
    const GElementID Connection;

//   this is left as a comment for idea gathering
//     /**
//      * consider the following situation:
//      * you hava a certain characteristic, for example you
//      * tend to be very happy; if something happens and you
//      * are quite unhappy for a few hours it does not mean
//      * that you are unhappy in general; likely you will
//      * recover and be (almost!!) happy as ever a few days
//      * later;
//      * (and maybe if you have learned something from the
//      * unexpected event so that afterwards you are even
//      * more happy - but this requires influence from your
//      * spirit...)
//      *
//      * so, if the energy changes for what reason ever
//      * this attribute could tell the "ordinary" state of
//      * the element;
//      *
//      * removed, because:
//      * the above comment actually is true, but we have to
//      * consider the way how we get unhappy when we are
//      * normally happy: if we get influenced by different
//      * circumstances than normal then it is likely that
//      * we also feel different; but this will go away as
//      * soon as the different influence also goes away!!
//      */
//    GEnergy LongTermEnergy;

    QValueList<GElementID> Children;

    
  public:

    GObject(GEnergy* energy,
            GForm* form,
            const GElementID& parent,
            const GElementID& ID,
            const GElementID& connection)
    : Energy(energy),
      Form(form),
      Parent(parent),
      ID(ID),
      Connection(connection)
    {
    }

    virtual ~GObject()
    {
      if (hasEnergy())
      {
        delete Energy;
        Energy = NULL;
      }
      if (hasForm())
      {
        delete Form;
        Form = NULL;
      }
    }

    // read methods:
    
    bool hasEnergy() const { return Energy ? true : false; }
    
    GEnergy* getEnergy() { Q_ASSERT(Energy); return Energy; }
    
    const GEnergy* getEnergy() const { Q_ASSERT(Energy); return Energy; }
    
    bool hasForm() const { return Form ? true : false; }
    
    GForm* getForm() { Q_ASSERT(Form); return Form; }
    
    const GForm* getForm() const { Q_ASSERT(Form); return Form; }
    
    const GElementID& getParent() const { return Parent; }
    
    const GElementID& getID() const { return ID; }
    
    const GElementID& getConnection() const { return Connection; }

    
    // methods for hierarchy management:
    
    void reparent(const GElementID& new_parent);

    void addChild(const GElementID&);
    
    bool isChild(const GElementID&) const;
    
    void removeChild(const GElementID&);
    
    QValueList<GElementID> getChildren() const;
};

}

#endif

---