amodworld.h

Go to the documentation of this file.

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


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

#include    <april/april.h>
#include    <april/cmd/aprilmodule.h>

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

namespace   april    {

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

class
    APRILSHARED_EXPORT
    AModWorld       : public AprilModule        {
    BBM_TRACK( AModWorld );

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

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

private:



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

public:

    AModWorld               ( CommandMap * cmd_map );

protected:

    virtual             ~AModWorld      ( void );
    
protected:

    virtual void        insertCommands  ( CommandMap * cm );

    virtual void        removeCommands  ( CommandMap * cm );
    
    virtual QString     name            ( void );


public:

    static bool         dOpenWorld      (
            const QString &         s_file,
            QString &               s_err           
            );

private:

    static bool         newWorld        (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );

    static bool         openWorld       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );

    static bool         saveWorld       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );

    static bool         closeWorld      (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );

    static bool         listWorld       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );
            
    static bool         startWorld      (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );
            
    static bool         stopWorld       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );
            
    static bool         advWorld        (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );
            
    static bool         crtWorld        (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err
            );
            
            
            
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //

};  /*  class AModWorld */

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

}   //  namespace   april

#endif // __AMODWORLD_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */