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 <Config.hpp>\r
  24 \r
  25 namespace SimGrid\r
  26 {\r
  27         namespace Msg\r
  28         {\r
  29                 class MsgException;\r
  30                 \r
  31                 /*! \brief init() - Initialize MSG (This function must be called at the begining of each simulation).\r
  32                  *\r
  33                  * \param argv                  A list of arguments.\r
  34                  * \param argc                  The number of arguments of the list.\r
  35                  */\r
  36                 SIMGRIDX_EXPORT void init(int argc, char** argv);\r
  37                 \r
  38                 /*! \brief finalize() - Finalize MSG (This function must be called at the end of each simulation).\r
  39                  *\r
  40                  * \exception                   If this function fails, it throws a exception describing the cause of the failure.\r
  41                  */\r
  42                 SIMGRIDX_EXPORT void finalize(void)\r
  43                 throw (MsgException);\r
  44                 \r
  45                 /*! \brief info() - Display information (using xbt log format).\r
  46                  *\r
  47                  * \param s                             The information to display.\r
  48                  */\r
  49                 SIMGRIDX_EXPORT void info(const char* s);\r
  50 \r
  51                 /*! \brief getClock() -  Retrieve the simulation time\r
  52                  *\r
  53                  * \return                              The current simulation time.\r
  54                  */\r
  55                 SIMGRIDX_EXPORT double getClock(void);\r
  56                 \r
  57         } // namespace Msg\r
  58 } // namespace SimGrid\r
  59 \r
  60 #endif // !MSG_HPP