src/cxx/Msg.hpp

   1 /*\r
   2  * Msg.hpp\r
   3  *\r
   4  * This file contains the declaration of the wrapper class of the native MSG task type.\r
   5  *\r
   6  * Copyright 2006,2007 Martin Quinson, Malek Cherier           \r
   7  * All right reserved. \r
   8  *\r
   9  * This program is free software; you can redistribute \r
  10  * it and/or modify it under the terms of the license \r
  11  *(GNU LGPL) which comes with this package. \r
  12  *\r
  13  */  \r
  14  \r
  15 #ifndef MSG_HPP\r
  16 #define MSG_HPP\r
  17 \r
  18 // Compilation C++ recquise\r
  19 #ifndef __cplusplus\r
  20         #error Msg.hpp requires C++ compilation (use a .cxx suffix)\r
  21 #endif\r
  22 \r
  23 #include <MsgException.hpp>\r
  24 \r
  25 namespace SimGrid\r
  26 {\r
  27         namespace Msg\r
  28         {\r
  29                 \r
  30                 /*! \brief init() - Initialize MSG (This function must be called at the begining of each simulation).\r
  31                  *\r
  32                  * \param argv                  A list of arguments.\r
  33                  * \param argc                  The number of arguments of the list.\r
  34                  */\r
  35                 static void init(int argc, char** argv);\r
  36                 \r
  37                 /* \brief finalize() - Finalize MSG (This function must be called at the end of each simulation).\r
  38                  *\r
  39                  * \exception                   If this function fails, it throws a exception describing the cause of the failure.\r
  40                  */\r
  41                 static void finalize(void)\r
  42                 throw (MsgException);\r
  43                 \r
  44                 /*! \brief info() - Display information (using xbt log format).\r
  45                  *\r
  46                  * \param s                             The information to display.\r
  47                  */\r
  48                 static void info(const char* s);\r
  49                 \r
  50                 \r
  51                 \r
  52                 \r
  53         } // namespace Msg\r
  54 } // namespace SimGrid\r
  55 \r
  56 #endif // !MSG_HPP