doc/gtut-tour.doc

   1 /** @defgroup GRAS_tut_tour Initiatic tour
   2     @ingroup GRAS_tut
   3
   4 During this tour, you will learn all you need to write your own GRAS
   5 applications, from the installation of the framework to the use of (almost)
   6 all features available in GRAS.
   7
   8     \htmlonly <!--
   9       DOXYGEN_NAVBAR_CHILD "0: Installing"=GRAS_tut_tour_install.html
  10       DOXYGEN_NAVBAR_CHILD "1: Setup a project"=GRAS_tut_tour_setup.html
  11       DOXYGEN_NAVBAR_CHILD "2: Simple messaging"=GRAS_tut_tour_simpleexchange.html
  12       DOXYGEN_NAVBAR_CHILD "3: Process args"=GRAS_tut_tour_args.html
  13       DOXYGEN_NAVBAR_CHILD "4: Callbacks"=GRAS_tut_tour_callbacks.html
  14       DOXYGEN_NAVBAR_CHILD "5: Globals"=GRAS_tut_tour_globals.html
  15       DOXYGEN_NAVBAR_CHILD "6: Logs"=GRAS_tut_tour_logs.html
  16       DOXYGEN_NAVBAR_CHILD "7: Timers"=GRAS_tut_tour_timers.html
  17       DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
  18       DOXYGEN_NAVBAR_CHILD "9: Data exchange"=GRAS_tut_tour_simpledata.html
  19       DOXYGEN_NAVBAR_CHILD "10: RPC"=GRAS_tut_tour_rpc.html
  20       DOXYGEN_NAVBAR_CHILD "11: Explicit wait"=GRAS_tut_tour_explicitwait.html
  21       DOXYGEN_NAVBAR_CHILD "Recapping part 1"=GRAS_tut_tour_message_recaping.html
  22       DOXYGEN_NAVBAR_CHILD "12: Static data definition"=GRAS_tut_tour_staticstruct.html
  23       DOXYGEN_NAVBAR_CHILD "13: Pointers definition"=GRAS_tut_tour_pointers.html
  24       DOXYGEN_NAVBAR_CHILD "14: Dynars definition"=GRAS_tut_tour_dynar.html
  25       DOXYGEN_NAVBAR_CHILD "15: Manual data definition"=GRAS_tut_tour_manualdatadef.html
  26       DOXYGEN_NAVBAR_CHILD "16: Advanced data definition"=GRAS_tut_tour_exchangecb.html
  27     --> \endhtmlonly
  28
  29 <b>Part 1: Bases</b>
  30
  31  - \ref GRAS_tut_tour_install
  32
  33  - \ref GRAS_tut_tour_setup
  34     - \ref GRAS_tut_tour_setup_C
  35     - \ref GRAS_tut_tour_setup_plat
  36     - \ref GRAS_tut_tour_setup_deploy
  37     - \ref GRAS_tut_tour_setup_glue
  38     - \ref GRAS_tut_tour_setup_make
  39     - \ref GRAS_tut_tour_setup_start
  40
  41 <b>Part 2: Message passing</b>
  42
  43  - \ref GRAS_tut_tour_simpleexchange
  44     - \ref GRAS_tut_tour_simpleexchange_msgtype
  45     - \ref GRAS_tut_tour_simpleexchange_socks
  46     - \ref GRAS_tut_tour_simpleexchange_exchange
  47     - \ref GRAS_tut_tour_simpleexchange_recaping
  48
  49  - \ref GRAS_tut_tour_args
  50     - \ref GRAS_tut_tour_args_use
  51     - \ref GRAS_tut_tour_args_sg
  52     - \ref GRAS_tut_tour_args_recap
  53
  54  - \ref GRAS_tut_tour_callbacks
  55     - \ref GRAS_tut_tour_callbacks_declare
  56     - \ref GRAS_tut_tour_callbacks_attach
  57     - \ref GRAS_tut_tour_callbacks_handle
  58     - \ref GRAS_tut_tour_callback_recap
  59
  60  - \ref GRAS_tut_tour_globals
  61     - \ref GRAS_tut_tour_globals_intro
  62     - \ref GRAS_tut_tour_globals_use
  63     - \ref GRAS_tut_tour_callback_pitfall
  64     - \ref GRAS_tut_tour_callback_recap
  65
  66  - \ref GRAS_tut_tour_logs
  67     - \ref GRAS_tut_tour_logs_intro
  68     - \ref GRAS_tut_tour_logs_practice
  69     - \ref GRAS_tut_tour_logs_recap
  70     - \ref GRAS_tut_tour_logs_config
  71       - \ref GRAS_tut_tour_logs_config_prio
  72       - \ref GRAS_tut_tour_logs_config_layout
  73
  74  - \ref GRAS_tut_tour_timers
  75     - \ref GRAS_tut_tour_timers_intro
  76     - \ref GRAS_tut_tour_timers_use
  77     - \ref GRAS_tut_tour_timers_recap
  78
  79  - \ref GRAS_tut_tour_exceptions
  80     - \ref GRAS_tut_tour_exceptions_intro
  81     - \ref GRAS_tut_tour_exceptions_use
  82     - \ref GRAS_tut_tour_exceptions_recap
  83
  84  - \ref GRAS_tut_tour_simpledata
  85     - \ref GRAS_tut_tour_simpledata_intro
  86       - \ref GRAS_tut_tour_simpledata_intro_conv
  87       - \ref GRAS_tut_tour_simpledata_intro_gras
  88       - \ref GRAS_tut_tour_simpledata_use
  89     - \ref GRAS_tut_tour_simpledata_example
  90     - \ref GRAS_tut_tour_simpledata_recap
  91
  92  - \ref GRAS_tut_tour_rpc
  93     - \ref GRAS_tut_tour_rpc_intro
  94     - \ref GRAS_tut_tour_rpc_use
  95       - \ref GRAS_tut_tour_rpc_use_declare
  96       - \ref GRAS_tut_tour_rpc_use_i2a_cb
  97       - \ref GRAS_tut_tour_rpc_use_a2i_cb
  98       - \ref GRAS_tut_tour_rpc_use_rest
  99     - \ref GRAS_tut_tour_rpc_recap
 100
 101  - \ref GRAS_tut_tour_explicitwait
 102     - \ref GRAS_tut_tour_explicitwait_intro
 103     - \ref GRAS_tut_tour_explicitwait_use
 104       - \ref GRAS_tut_tour_explicitwait_algo
 105       - \ref GRAS_tut_tour_explicitwait_code
 106         - \ref GRAS_tut_tour_explicitwait_code_msg
 107         - \ref GRAS_tut_tour_explicitwait_code_cb
 108         - \ref GRAS_tut_tour_explicitwait_code_api
 109         - \ref GRAS_tut_tour_explicitwait_code_smain
 110         - \ref GRAS_tut_tour_explicitwait_code_cmain
 111     - \ref GRAS_tut_tour_explicitwait_recap
 112
 113  - \ref GRAS_tut_tour_message_recaping
 114     - \ref GRAS_tut_tour_message_recaping_intro
 115     - \ref GRAS_tut_tour_message_recaping_rpc
 116       - \ref GRAS_tut_tour_message_recaping_rpc1
 117       - \ref GRAS_tut_tour_message_recaping_rpc2
 118       - \ref GRAS_tut_tour_message_recaping_rpc3
 119       - \ref GRAS_tut_tour_message_recaping_rpc4
 120       - \ref GRAS_tut_tour_message_recaping_rpc5
 121       - \ref GRAS_tut_tour_message_recaping_rpc_aside1
 122       - \ref GRAS_tut_tour_message_recaping_rpc_aside2
 123       - \ref GRAS_tut_tour_message_recaping_rpc_aside3
 124     - \ref GRAS_tut_tour_message_recaping_sync
 125
 126 <b>Part 3: Data description</b>
 127
 128  - \ref GRAS_tut_tour_staticstruct
 129     - \ref GRAS_tut_tour_staticstruct_intro
 130     - \ref GRAS_tut_tour_staticstruct_use
 131     - \ref GRAS_tut_tour_staticstruct_recap
 132
 133  - \ref GRAS_tut_tour_pointers
 134     - \ref GRAS_tut_tour_pointers_intro
 135     - \ref GRAS_tut_tour_pointers_use
 136     - \ref GRAS_tut_tour_pointers_recap
 137     - \ref GRAS_tut_tour_pointers_cste
 138
 139  - \ref GRAS_tut_tour_dynar
 140     - \ref GRAS_tut_tour_dynar_intro
 141     - \ref GRAS_tut_tour_dynar_use
 142     - \ref GRAS_tut_tour_dynar_recap
 143
 144  - \ref GRAS_tut_tour_manualdatadef
 145     - \ref GRAS_tut_tour_manualdatadef_intro
 146     - \ref GRAS_tut_tour_manualdatadef_use
 147     - \ref GRAS_tut_tour_manualdatadef_recap
 148
 149  - \ref GRAS_tut_tour_exchangecb
 150     - \ref GRAS_tut_tour_exchangecb_intro
 151     - \ref GRAS_tut_tour_exchangecb_use
 152     - \ref GRAS_tut_tour_exchangecb_recap
 153
 154 <b>Part 4: Advanced topics</b>
 155
 156 Unfortunately, the tour is not terminated yet, but I already know the kind
 157 of missi^W lessons I want to add:
 158
 159    - Computation virtualization
 160    - Splitting in several files (logs, datadesc)
 161    - Debugging GRAS programs
 162    - Doing proper GRAS modules
 163
 164 <hr>
 165
 166
 167
 168 */