X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c5714d903c9d1e7e3c88e5ee7b6e5b1d098eeab9..82cf3d43c742ba91f7c78bae73a0926c8ca71cd6:/src/include/surf/surf.hpp diff --git a/src/include/surf/surf.hpp b/src/include/surf/surf.hpp index 146f104e09..410508c4b2 100644 --- a/src/include/surf/surf.hpp +++ b/src/include/surf/surf.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -7,43 +7,19 @@ #define SURF_SURF_H #include "simgrid/forward.h" -#include "xbt/graph.h" -/***************************/ -/* Generic model object */ -/***************************/ - -/** @{ @ingroup SURF_c_bindings */ - -/** - * @brief [brief description] - * @details [long description] - * - * @param action The surf cpu action - * @param bound [description] - */ -XBT_PUBLIC void surf_cpu_action_set_bound(simgrid::kernel::resource::Action* action, double bound); - -/** @} */ - -/**************************************/ -/* Implementations of model object */ -/**************************************/ - -/** \ingroup SURF_models - * \brief The CPU model object for the physical machine layer +/** @ingroup SURF_models + * @brief The CPU model object for the physical machine layer */ -XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_pm; +XBT_PUBLIC_DATA simgrid::kernel::resource::CpuModel* surf_cpu_model_pm; -/** \ingroup SURF_models - * \brief The CPU model object for the virtual machine layer +/** @ingroup SURF_models + * @brief The CPU model object for the virtual machine layer */ -XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_vm; - -XBT_PUBLIC_DATA simgrid::surf::StorageModel* surf_storage_model; +XBT_PUBLIC_DATA simgrid::kernel::resource::CpuModel* surf_cpu_model_vm; -/** \ingroup SURF_models - * \brief The host model +/** @ingroup SURF_models + * @brief The host model * * Note that when you create an API on top of SURF, the host model should be the only one you use * because depending on the platform model, the network model and the CPU model may not exist. @@ -53,29 +29,29 @@ XBT_PUBLIC_DATA simgrid::surf::HostModel* surf_host_model; /*** SURF Globals **************************/ -/** \ingroup SURF_simulation - * \brief Initialize SURF - * \param argc argument number - * \param argv arguments +/** @ingroup SURF_simulation + * @brief Initialize SURF + * @param argc argument number + * @param argv arguments * * This function has to be called to initialize the common structures. Then you will have to create the environment by * calling e.g. surf_host_model_init_CM02() * - * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit() + * @see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit() */ XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */ -/** \ingroup SURF_simulation - * \brief Finish simulation initialization +/** @ingroup SURF_simulation + * @brief Finish simulation initialization * * This function must be called before the first call to surf_solve() */ XBT_PUBLIC void surf_presolve(); -/** \ingroup SURF_simulation - * \brief Performs a part of the simulation - * \param max_date Maximum date to update the simulation to, or -1 - * \return the elapsed time, or -1.0 if no event could be executed +/** @ingroup SURF_simulation + * @brief Performs a part of the simulation + * @param max_date Maximum date to update the simulation to, or -1 + * @return the elapsed time, or -1.0 if no event could be executed * * This function execute all possible events, update the action states and returns the time elapsed. * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only @@ -84,23 +60,23 @@ XBT_PUBLIC void surf_presolve(); */ XBT_PUBLIC double surf_solve(double max_date); -/** \ingroup SURF_simulation - * \brief Return the current time +/** @ingroup SURF_simulation + * @brief Return the current time * * Return the current time in millisecond. */ XBT_PUBLIC double surf_get_clock(); -/** \ingroup SURF_simulation - * \brief Exit SURF +/** @ingroup SURF_simulation + * @brief Exit SURF * * Clean everything. * - * \see surf_init() + * @see surf_init() */ XBT_PUBLIC void surf_exit(); /* surf parse file related (public because called from a test suite) */ -XBT_PUBLIC void parse_platform_file(const char* file); +XBT_PUBLIC void parse_platform_file(const std::string& file); #endif