doc/gtut-tour.doc

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