/* this_actor namespace */
m.def("execute", py::overload_cast<double>(&simgrid::s4u::this_actor::execute),
- "Block the actor, computing the given amount of flops");
+ "Block the current actor, computing the given amount of flops, see :cpp:func:`void simgrid::s4u::this_actor::execute(double)`");
m.def("execute", py::overload_cast<double, double>(&simgrid::s4u::this_actor::execute),
- "Block the actor, computing the given amount of flops at the given priority");
- m.def("yield_", &simgrid::s4u::this_actor::yield, "Yield the actor");
+ "Block the current actor, computing the given amount of flops at the given priority, see :cpp:func:`void simgrid::s4u::this_actor::execute(double, double)`");
+ m.def("yield_", &simgrid::s4u::this_actor::yield, "Yield the actor, see :cpp:func:`void simgrid::s4u::this_actor::yield()`");
/* Class Engine */
- py::class_<Engine>(m, "Engine")
+ py::class_<Engine>(m, "Engine", "Simulation Engine, see :ref:`class s4u::Engine <API_s4u_Engine>`")
.def(py::init([](std::vector<std::string> args) -> simgrid::s4u::Engine* {
static char noarg[] = {'\0'};
int argc = args.size();
// Currently this can be dangling, we should wrap this somehow.
return new simgrid::s4u::Engine(&argc, argv.get());
}))
- .def("load_platform", &Engine::load_platform, "Load a platform file describing the environment")
- .def("load_deployment", &Engine::load_deployment, "Load a deployment file and launch the actors that it contains")
+ .def("load_platform", &Engine::load_platform,
+ "Load a platform file describing the environment, see :cpp:func:`simgrid::s4u::Engine::load_platform()`")
+ .def("load_deployment", &Engine::load_deployment,
+ "Load a deployment file and launch the actors that it contains, see :cpp:func:`simgrid::s4u::Engine::load_deployment()`")
.def("run", &Engine::run, "Run the simulation")
.def("register_function", [](Engine*, std::string name, std::function<void(std::vector<std::string>)> f) {
simgrid::simix::register_function(name,
[f](std::vector<std::string> args) -> simgrid::simix::ActorCode {
return [args, f]() { f(args); };
});
- }, "Registers the main function of an actor that will be launched from the deployment file");
+ }, "Registers the main function of an actor that will be launched from the deployment file, , see :cpp:func:`simgrid::s4u::Engine::register_function()`");
- // Currently, Host lead to segfault:
- py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host").def(
+ /* Class Host */
+ py::class_<simgrid::s4u::Host, std::unique_ptr<Host, py::nodelete>>(m, "Host", "Simulation Engine, see :ref:`class s4u::Host <API_s4u_Host>`").def(
"by_name", &Host::by_name, "Retrieve a host from its name, or die");
- py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor", "An actor is an independent stream of execution in your distributed application");
-
+ /* Class Actor */
// Select the right template instantiation
simgrid::s4u::ActorPtr (*create_actor)(std::string, Host*, std::function<void()>) = &Actor::create;
- m.def("create_actor", create_actor, "Create an actor");
- m.def("create_actor", [](std::string name, Host* host) -> std::function<ActorPtr(std::function<void()>)> {
- return [name, host](std::function<void()> f) -> ActorPtr {
- return simgrid::s4u::Actor::create(name, host, std::move(f));
- };
- }, "Create an actor");
+ py::class_<simgrid::s4u::Actor, ActorPtr>(m, "Actor", ""
+ "An actor is an independent stream of execution in your distributed application, see :ref:`class s4u::Actor <API_s4u_Actor>`")
+ .def("create", create_actor, "Create an actor from a function, see :cpp:func:`simgrid::s4u::Actor::create()`")
+ .def("create", [](std::string name, Host* host) -> std::function<ActorPtr(std::function<void()>)> {
+ return [name, host](std::function<void()> f) -> ActorPtr {
+ return simgrid::s4u::Actor::create(name, host, std::move(f));
+ };
+ }, "Create an actor from a functor");
+
+
}
