From 36c071f0028ae457d6229b844dff5640f13616b9 Mon Sep 17 00:00:00 2001 From: schnorr Date: Sat, 24 Mar 2012 22:12:29 +0100 Subject: [PATCH] [trace] documenting function that creates a dot file from a SimGrid platform file as always in the trace world: - nodes, links and routers are graph nodes - routes are graph edges --- src/instr/instr_interface.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c index 83ce6be28b..c334dc96c6 100644 --- a/src/instr/instr_interface.c +++ b/src/instr/instr_interface.c @@ -230,6 +230,17 @@ static void instr_user_srcdst_variable(double time, } } +/** \ingroup TRACE_API + * \brief Creates a file with the topology of the platform file used for the simulator. + * + * The graph topology will have the following properties: all hosts, links and routers + * of the platform file are mapped to graph nodes; routes are mapped to edges. + * The platform's AS are not represented in the output. + * + * \param filename The name of the file that will hold the graph. + * + * \return 1 of successful, 0 otherwise. + */ int TRACE_platform_graph_export_graphviz (const char *filename) { /* returns 1 if successful, 0 otherwise */ -- 2.20.1