world.h

Go to the documentation of this file.

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


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

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

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

namespace   april    {

class ActorComp;
class Actor;
class Director;
class World;
class EventSource;
class Actuator;
class Brain;
class Sensor;
class Reflex;
class EventLine;

class ActorFactory;
class ActuatorFactory;
class BrainFactory;
class SensorFactory;
class EventFactory;
class ReflexFactory;

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

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

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

    friend class Actor;
    friend class Director;
    friend class EventSource;
    friend class Factory;
    friend class EventLine;
    friend class ActorFactory;
    friend class ActuatorFactory;
    friend class BrainFactory;
    friend class SensorFactory;
    friend class EventFactory;
    friend class ReflexFactory;

    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:

    bool                        b_running_:1;

    QString                     s_name_;

    QString                     s_file_;
    
    quint64                     time_;
    
    quint64                     energy_all_;
    
    quint64                     energy_free_;

    List2Dh                     actors_;
    
    List2Dh                     events_;
    
    UniqueId                    uid_;
    
    QMap<ID,ActorFactory*>      actor_factories_;
    
    QMap<ID,ActuatorFactory*>   actuator_factories_;
        
    QMap<ID,BrainFactory*>      brain_factories_;
        
    QMap<ID,SensorFactory*>     sensor_factories_;
        
    QMap<ID,EventFactory*>      event_factories_;
        
    QMap<ID,ReflexFactory*>     reflex_factories_;
    
    QMap<ID,EventLine*>         event_lines_;
    
    Director *                  director_;

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

public:

    World               ( const QString & name, quint64 tot_energ );

    Q_REQUIRED_RESULT
    static World *      fromStg             ( QSettings & s );
    
    Q_REQUIRED_RESULT
    static World *      fromStg             (
            const QString &         s_file,
            QString &               s_err
            );

protected:

    virtual             ~World              ( void );


public:

    const QString &     name                ( void ) const
    { return s_name_; }

    quint64             currentTime         ( void ) const
    { return time_; }
    
    void                advance             ( void );
    
    virtual QString     factoryName         ( void ) const;

    const QString &     associatedFile      ( void ) const
    { return s_file_; }

    bool                hasAssociatedFile   ( void ) const
    { return s_file_.isEmpty() == false; }
    
    void                setAssociatedFile   ( const QString & s_val )
    { s_file_ = s_val; }
    

    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:

    inline Director *           director            ( void ) const
    { return director_; }
    
    bool                        setDirector         ( Director * new_val );
    
    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

    bool                start               ( void );

    void                stop                ( void );

    bool                isRunning           ( void ) const
    { return b_running_; }

protected:

    void                stepTime            ( void )
    { time_++; }


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

    
    quint64             energy              ( void ) const
    { return energy_all_; }
    
    quint64             energyFree          ( void ) const
    { return energy_free_; }    
    
    quint64             energyBounded       ( void ) const
    { return energy_all_ - energy_free_; }  
    
    bool                setTotEnergy        ( quint64 new_val );
    
protected:
    

    bool                setEnergy           (
            ActorComp *             comp, 
            quint64                 energy, 
            quint64                 cost 
            );

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

    const QMap<ID,ActorFactory*> &      actorFactories      ( void ) const
    { return actor_factories_; }
    
    const QMap<ID,ActuatorFactory*> &   actuatorFactories   ( void ) const
    { return actuator_factories_; }
        
    const QMap<ID,BrainFactory*> &      brainFactories      ( void ) const
    { return brain_factories_; }
        
    const QMap<ID,SensorFactory*> &     sensorFactories     ( void ) const
    { return sensor_factories_; }
        
    const QMap<ID,EventFactory*> &      eventFactories      ( void ) const
    { return event_factories_; }
        
    const QMap<ID,ReflexFactory*> &     reflexFactories     ( void ) const
    { return reflex_factories_; }


    ActorFactory*                       actorFactory        ( ID id ) const
    { return actor_factories_.value( id, NULL ); }
    
    ActuatorFactory*                    actuatorFactory     ( ID id ) const
    { return actuator_factories_.value( id, NULL ); }
        
    BrainFactory*                       brainFactory        ( ID id ) const
    { return brain_factories_.value( id, NULL ); }
        
    SensorFactory*                      sensorFactory       ( ID id ) const
    { return sensor_factories_.value( id, NULL ); }
        
    EventFactory*                       eventFactory        ( ID id ) const
    { return event_factories_.value( id, NULL ); }
        
    ReflexFactory*                      reflexFactory       ( ID id ) const
    { return reflex_factories_.value( id, NULL ); }
    

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:


    ID              idValue         ( const QString & s_name )
    { return uid_.value( s_name ); }

    void            insertId        ( ID id, const QString & s_name )
    { uid_.insert( id, s_name ); }
    
    ID              addNewId        ( const QString & s_name = QString() )
    { return uid_.addNew( s_name ); }
    
    ID              checkAddId      ( const QString & s_name )
    { return uid_.checkAdd( s_name ); }
    
    void            checkAddId      ( ID id, const QString & s_name )
    { uid_.checkAdd( id, s_name ); }

    QString         nameForId       ( ID id )
    { return uid_.name( id ); }

    bool            sameUId         ( World * other ) const
    { return uid_ == other->uid_; }

    QString         createIdName    ( const QString & s_pattern )
    { return uid_.createName( s_pattern ); }

    QList<ID>       allocatedIds    ( void ) const
    { return uid_.ids(); }

    bool            isIDAssigned    ( ID id ) const
    { return uid_.isAssigned( id ); }
    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

    Actor *         firstActor          ( void ) const;

    Actor *         actorAt             ( int i ) const;


    bool            killActor           ( Actor * a );
    
protected:

    bool            addActor            ( Actor * act );

    bool            remActor            ( Actor * act );

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */
    
    
    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:
    
    EventSource *   firstEvent          ( void ) const;

protected:

    bool            addEvent            ( EventSource * act );

    bool            remEvent            ( EventSource * act );
    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */

    
    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:
    
    inline EventLine *  eventLine           ( ID id )
    { return event_lines_.value( id, NULL ); }
    
protected:

    bool            addEventLine        ( EventLine * el, ID id );
    
    bool            remEventLine        ( EventLine * el, ID id );

    QMap<ID,EventLine*>::ConstIterator  firstEventLine      ( void )
    { return event_lines_.constBegin(); }

    QMap<ID,EventLine*>::ConstIterator  endEventLine        ( void )
    { return event_lines_.constEnd(); }

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */

    
public:

    bool            addActorFactory     ( ActorFactory * factory, ID id );

    bool            addActuatorFactory  ( ActuatorFactory * factory, ID id );

    bool            addSensorFactory    ( SensorFactory * factory, ID id );

    bool            addBrainFactory     ( BrainFactory * factory, ID id );

    bool            addEventFactory     ( EventFactory * factory, ID id );

    bool            addReflexFactory    ( ReflexFactory * factory, ID id );
    

    bool            remActorFactory     ( ActorFactory * factory, ID id );

    bool            remActuatorFactory  ( ActuatorFactory * factory, ID id );

    bool            remSensorFactory    ( SensorFactory * factory, ID id );

    bool            remBrainFactory     ( BrainFactory * factory, ID id );

    bool            remEventFactory     ( EventFactory * factory, ID id );

    bool            remReflexFactory    ( ReflexFactory * factory, ID id );
    
    

    ActorFactory*   findActorFactory    ( const QString & s_name );

    ActuatorFactory*findActuatorFactory ( const QString & s_name );

    SensorFactory*  findSensorFactory   ( const QString & s_name );

    BrainFactory*   findBrainFactory    ( const QString & s_name );

    EventFactory*   findEventFactory    ( const QString & s_name );

    ReflexFactory*  findReflexFactory   ( const QString & s_name );
    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:


    Actor *         createActor         ( ID id_kind );
    
    Actuator *      createActuator      ( Actor * actor, ID id );
    
    Brain *         createBrain         ( Actor * actor, ID id );
    
    Sensor *        createSensor        ( Actor * actor, ID id );
    
    EventSource *   createEvent         ( ID id );
    
    Reflex *        createReflex        ( Actor * actor, ID id );
    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO */


public:

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


    virtual bool    saveAsStg           ( 
            const QString &         s_file,
            QString &               s_err
            ) const;

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */



    void            actorDies           ( Actor * actor );




    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class World */

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

}   //  namespace   april

#endif // __WORLD_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */