actor.h

Go to the documentation of this file.

/* ========================================================================= */
/* ------------------------------------------------------------------------- *//*


 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Please read COPYING and README files in root folder
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/* ------------------------------------------------------------------------- */
/* ========================================================================= */
#ifndef __ACTOR_INC__
#define __ACTOR_INC__
//
//
//
//
/*  INCLUDES    ------------------------------------------------------------ */

#include    <april/april.h>
#include    <april/logic/component.h>
#include    <april/logic/dna.h>

/*  INCLUDES    ============================================================ */
//
//
//
//
/*  DEFINITIONS    --------------------------------------------------------- */

namespace   april    {

class World;
class Sensor;
class Actuator;
class Brain;
class Actor;
class Reflex;
class Director;

/*  DEFINITIONS    ========================================================= */
//
//
//
//
/*  CLASS    --------------------------------------------------------------- */

class
    APRILSHARED_EXPORT
    Actor       : public Component      {
    BBM_TRACK( Actor );

    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */

    friend class Director;
    friend class Sensor;
    friend class Actuator;
    friend class World;
    friend class Reflex;
    friend class Brain;
    friend class ActorFactory;
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:

    World *                 world_;

    List2Dh                 sensors_;
    
    List2Dh                 actuators_;
    
    List2Dh                 reflexes_;
    
    List2Dh                 brains_;
    
    DNA                     dna_;
    
    ID                      kind_;

    quint64                 birth_;
    
    quint64                 death_;
    
    quint64                 age_;
    
    quint64                 energy_;
    

    quint64                 cost_;

    bool                    alive_;




    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */

public:


    Actor               ( World * w );

    Q_REQUIRED_RESULT
    static Actor *      fromStg                 ( World * w, QSettings & s );

protected:

    virtual             ~Actor                  ( void );

public:

    virtual bool        save                    ( QSettings & s ) const;
    
    virtual bool        load                    ( QSettings & s );

    virtual ID          identificator           ( void ) const
    { return kind(); }

    virtual Factory *   factory                 ( void ) const;
    
protected:


    void                killMe                  ( void );
    
    
    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:

    Sensor *            firstSensor             ( void ) const;
    
    Actuator *          firstActuator           ( void ) const;
    
    Reflex *            firstReflex             ( void ) const;
    
    Brain *             firstBrain              ( void ) const;

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:

    Sensor *            findSensor              ( ID id ) const;
    
    Actuator *          findActuator            ( ID id ) const;
    
    Reflex *            findReflex              ( ID id ) const;
    
    Brain *             findBrain               ( ID id ) const;

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

    inline World *      world                   ( void ) const
    { return world_; }

    inline ID           kind                    ( void ) const
    { return kind_; }
    
    QString             kindName                ( void ) const;
    
    const DNA &         dna                     ( void ) const
    { return dna_; }

    inline quint64      birth                   ( void ) const
    { return birth_; }
    
    inline quint64      death                   ( void ) const
    { return death_; }
    
    inline quint64      age                     ( void ) const
    { return age_; }
    
    inline quint64      toLive                  ( void ) const
    { return death_-birth_; }
    
    quint64             energy                  ( void ) const
    { return energy_; }

    quint64             totalEnergy             ( void ) const;
    
    quint64             cost                    ( void ) const
    { return cost_; }

    bool                isAlive                 ( void ) const
    { return alive_; }
    
    inline bool         dies                    ( void ) const
    { return (birth_+age_ >= death_); }

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


protected:

    inline void         setDNA                  ( const DNA & src )
    { dna_ = src; }

    bool                decodeDNA               ( void );

    bool                addActuator             ( Actuator * act );

    bool                addSensor               ( Sensor * act );

    bool                addReflex               ( Reflex * act );

    bool                addBrain                ( Brain * act );

    bool                remActuator             ( Actuator * act );

    bool                remSensor               ( Sensor * act );

    bool                remReflex               ( Reflex * act );

    bool                remBrain                ( Brain * act );

    void                doSteps                 ( int steps  = 1 );

    void                makeAlive               ( void );

    void                setEnergy               ( quint64 new_val )
    { energy_ = new_val; }

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //

};  /*  class Actor */

/*  CLASS    =============================================================== */
//
//
//
//

}   //  namespace   april

#endif // __ACTOR_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */