~ubuntu-branches/ubuntu/quantal/simgrid/quantal

« back to all changes in this revision

Viewing changes to doc/html/group__TRACE__mark.html

  • Committer: Package Import Robot
  • Author(s): Lucas Nussbaum, Martin Quinson, Lucas Nussbaum
  • Date: 2012-06-09 16:24:44 UTC
  • mfrom: (10.1.4 sid)
  • Revision ID: package-import@ubuntu.com-20120609162444-xook34f3d6qy5ixj
Tags: 3.7.1-1
[ Martin Quinson ]
* debian/copyright: update FSF address (thanks lintian for noticing)

[ Lucas Nussbaum ]
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
5
<title>SimGrid: Tracing marks</title>
7
 
 
8
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
 
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
 
 
11
 
 
12
 
 
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
13
8
<link href="simgrid.css" rel="stylesheet" type="text/css">
14
9
</head>
15
10
<body>
16
 
<div id="top"><!-- do not remove this div! -->
17
 
 
18
 
 
 
11
<!-- Generated by Doxygen 1.7.4 -->
 
12
<div id="top">
19
13
<div id="titlearea">
20
14
<table cellspacing="0" cellpadding="0">
21
15
 <tbody>
22
16
 <tr style="height: 56px;">
23
 
  
24
 
  
25
17
  <td style="padding-left: 0.5em;">
26
 
   <div id="projectname">SimGrid
27
 
   &#160;<span id="projectnumber">3.7</span>
28
 
   </div>
 
18
   <div id="projectname">SimGrid&#160;<span id="projectnumber">3.7.1</span></div>
29
19
   <div id="projectbrief">Scalable simulation of distributed systems</div>
30
20
  </td>
31
 
  
32
 
  
33
 
  
34
21
 </tr>
35
22
 </tbody>
36
23
</table>
37
24
</div>
38
 
 
39
 
<!-- Generated by Doxygen 1.7.6.1 -->
40
25
  <div id="navrow1" class="tabs">
41
26
    <ul class="tablist">
42
27
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
65
50
  <li> <a href="group__API__index.html"><span>Full Index</span></a></li>
66
51
  <li> <a href="group__XBT__API.html"><span>XBT</span></a></li>
67
52
  <li> <a href="group__MSG__API.html"><span>MSG</span></a></li>
 
53
  <li> <a href="group__SIMIX__API.html"><span>SIMIX</span></a></li>
68
54
  <li> <a href="group__GRAS__API.html"><span>GRAS</span></a></li>
69
55
  <li> <a href="group__AMOK__API.html"><span>AMOK</span></a></li>
70
56
  <li> <a href="group__SMPI__API.html"><span>SMPI</span></a></li>
89
75
<a href="#func-members">Functions</a>  </div>
90
76
  <div class="headertitle">
91
77
<div class="title">Tracing marks</div>  </div>
92
 
<div class="ingroups"><a class="el" href="group__TRACE__API.html">TRACE</a></div></div><!--header-->
 
78
<div class="ingroups"><a class="el" href="group__TRACE__API.html">TRACE</a></div></div>
93
79
<div class="contents">
94
80
 
95
81
<p>Functions to declare and create tracing marks.  
112
98
<div class="memproto">
113
99
      <table class="memname">
114
100
        <tr>
115
 
          <td class="memname">void <a class="el" href="group__TRACE__mark.html#gacd215a0072a5d4ec7c5b11610b7bef20">TRACE_declare_mark</a> </td>
 
101
          <td class="memname">void TRACE_declare_mark </td>
116
102
          <td>(</td>
117
103
          <td class="paramtype">const char *&#160;</td>
118
104
          <td class="paramname"><em>mark_type</em></td><td>)</td>
124
110
 
125
111
<p>Declare a new type for tracing mark. </p>
126
112
<p>This function declares a new Paje event type in the trace file that can be used by simulators to declare application-level marks. This function is independent of which API is used in SimGrid.</p>
127
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
113
<dl><dt><b>Parameters:</b></dt><dd>
128
114
  <table class="params">
129
115
    <tr><td class="paramname">mark_type</td><td>The name of the new type.</td></tr>
130
116
  </table>
139
125
<div class="memproto">
140
126
      <table class="memname">
141
127
        <tr>
142
 
          <td class="memname">void <a class="el" href="group__TRACE__mark.html#gac8f263e9033090c2e73c7a2e2a98088a">TRACE_mark</a> </td>
 
128
          <td class="memname">void TRACE_mark </td>
143
129
          <td>(</td>
144
130
          <td class="paramtype">const char *&#160;</td>
145
131
          <td class="paramname"><em>mark_type</em>, </td>
161
147
 
162
148
<p>Create a new instance of a tracing mark type. </p>
163
149
<p>This function creates a mark in the trace file. The first parameter had to be previously declared using <a class="el" href="group__TRACE__mark.html#gacd215a0072a5d4ec7c5b11610b7bef20" title="Declare a new type for tracing mark.">TRACE_declare_mark</a>, the second is the identifier for this mark instance. We recommend that the mark_value is a unique value for the whole simulation. Nevertheless, this is not a strong requirement: the trace will be valid even if there are multiple mark identifiers for the same trace.</p>
164
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
150
<dl><dt><b>Parameters:</b></dt><dd>
165
151
  <table class="params">
166
152
    <tr><td class="paramname">mark_type</td><td>The name of the type for which the new instance will belong. </td></tr>
167
153
    <tr><td class="paramname">mark_value</td><td>The name of the new instance mark.</td></tr>
177
163
<div class="memproto">
178
164
      <table class="memname">
179
165
        <tr>
180
 
          <td class="memname"><a class="el" href="group__XBT__dynar__cons.html#gac826571988d2b63ae225e5c62ecdbc79">xbt_dynar_t</a> <a class="el" href="group__TRACE__mark.html#ga6012125dd57ddf958895a8007280bbf5">TRACE_get_marks</a> </td>
 
166
          <td class="memname"><a class="el" href="group__XBT__dynar__cons.html#gac826571988d2b63ae225e5c62ecdbc79">xbt_dynar_t</a> TRACE_get_marks </td>
181
167
          <td>(</td>
182
168
          <td class="paramtype">void&#160;</td>
183
169
          <td class="paramname"></td><td>)</td>
193
179
 
194
180
</div>
195
181
</div>
196
 
</div><!-- contents -->
 
182
</div>
197
183
<p>
198
184
<hr>
199
185
 
204
190
Back to the main Simgrid Documentation page</b></a>
205
191
</td>
206
192
<td align=middle>
207
 
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.<br/>
 
193
<small>The version of <a href="http://simgrid.gforge.inria.fr">SimGrid</a> documented here is v3.7.1.<br/>
208
194
Documentation of other versions can be found in their respective
209
195
archive files (directory doc/html).
210
196
</td>