GAgent.h

/***************************************************************************
 *   Copyright (C) 2003-2006 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 GAGENTH
#define GAGENTH

#include <QThread>
#include <QStringList>
#include <qdom.h>


namespace GCS
{

class GElement;
class GObject;
class GEnergy;
class GForm;
class GVector3;
class GMatrix44;
class GElementID;
class GElementInfluence;
class GElementData;

class GAgent : protected QThread
{
  //make this class a Q_OBJECT, which means that signals
  //and slots can be used (see Qt documentation)
  Q_OBJECT

  private:
    GObject* Object;
    
    QList<GAgent*>* Agents;
    
  protected:
    
    bool shutdown;
     
  public:

    GAgent();

    virtual ~GAgent() {}
    
    const GElementID& getElementID() const;
    
    virtual QString getAgentName() const;

    virtual QStringList getAvailableActions() const;
    
    virtual QString getActionDescription(const QString& action) const;

  protected:
  
    virtual void run();
    
    bool msleepCheckShutdown(unsigned long msecs, unsigned long checkinterval = 5000);
  
    GObject* requestObject();
    
    const GObject* requestObject() const;
    
    GEnergy* requestEnergy();
    
    const GEnergy* requestEnergy() const;
    
    GForm* requestForm();
    
    const GForm* requestForm() const;
    
    GElementData* requestElementData();
    
    const GElementData* requestElementData() const;
    
    QList<const GAgent*> requestAgents() const;
    
    const GElementID& getConnectionID() const;
    
  protected slots:
  
    virtual void beginPark();
      
    virtual void threadStart(double seconds_elapsed);

  public slots:

    virtual void receiveInfluence(const GCS::GElementInfluence&);

    virtual void performAction(const QString& action, QStringList params);
    
    virtual void reparented(const GCS::GElementID& old_parent, const GCS::GElementID& new_parent, const GCS::GMatrix44& transformation);

  signals:

    void sendInfluence(const GCS::GElementInfluence& influence, const GCS::GElementID& destination);

    void radiateInfluence(const GCS::GElementInfluence& influence, double radius_factor);
    
    void parentChanged(const GCS::GElementID& newParent, const GCS::GElementID& oldParent, const GCS::GMatrix44& transformation);
    
    void energyChanged(const GCS::GEnergy& changedEnergy);

    void formChanged(const GCS::GForm& changedForm);

    void elementDataChanged(const QString& xmlpath);
    
    void childElementCreated(GCS::GElement* newElement);
    
    void childElementRemoved(const GCS::GElementID& childID);
    
    
  public:
  
    virtual bool isParked() const;
      
    friend class GElement;
    
};

}

#endif

---