2
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
5
6
<title>SimGrid: surf_action Struct Reference</title>
6
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
10
<link href="navtree.css" rel="stylesheet" type="text/css"/>
11
<script type="text/javascript" src="resize.js"></script>
12
<script type="text/javascript" src="navtree.js"></script>
13
<script type="text/javascript">
14
$(document).ready(initResizable);
16
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17
<script type="text/javascript" src="search/search.js"></script>
18
<script type="text/javascript">
19
$(document).ready(function() { searchBox.OnSelectItem(0); });
21
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
10
<!-- Generated by Doxygen 1.7.4 -->
24
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
12
25
<div id="titlearea">
13
26
<table cellspacing="0" cellpadding="0">
15
28
<tr style="height: 56px;">
16
29
<td style="padding-left: 0.5em;">
17
<div id="projectname">SimGrid <span id="projectnumber">3.7.1</span></div>
18
<div id="projectbrief">Scalable simulation of distributed systems</div>
30
<div id="projectname">SimGrid
31
 <span id="projectnumber">3.9</span>
33
<div id="projectbrief">Versatile Simulation of Distributed Systems</div>
24
<div id="navrow1" class="tabs">
26
<li><a href="index.html"><span>Main Page</span></a></li>
27
<li><a href="pages.html"><span>Related Pages</span></a></li>
28
<li><a href="modules.html"><span>Modules</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Data Structures</span></a></li>
35
<li><a href="functions.html"><span>Data Fields</span></a></li>
39
<div id="navrow1" class="tabs">
41
<li><a href="http://simgrid.gforge.inria.fr/"><span>Home page</span></a></li>
42
<li><a href="http://simgrid.gforge.inria.fr/documentation.html"><span>Online documentation</span></a></li>
43
<li><a href="https://gforge.inria.fr/projects/simgrid"><span>Dev's Corner</span></a></li>
44
<li> <div id="MSearchBox" class="MSearchBoxInactive">
46
<img id="MSearchSelect" src="search/mag_sel.png"
47
onmouseover="return searchBox.OnSearchSelectShow()"
48
onmouseout="return searchBox.OnSearchSelectHide()"
50
<input type="text" id="MSearchField" value="Search" accesskey="S"
51
onfocus="searchBox.OnSearchFieldFocus(true)"
52
onblur="searchBox.OnSearchFieldFocus(false)"
53
onkeyup="searchBox.OnSearchFieldChange(event)"/>
54
</span><span class="right">
55
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
61
<!-- end header part -->
62
<!-- Generated by Doxygen 1.8.1.2 -->
63
<script type="text/javascript">
64
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67
<div id="side-nav" class="ui-resizable side-nav-resizable">
69
<div id="nav-tree-contents">
70
<div id="nav-sync" class="sync"></div>
73
<div id="splitbar" style="-moz-user-select:none;"
74
class="ui-resizable-handle">
77
<script type="text/javascript">
78
$(document).ready(function(){initNavTree('structsurf__action.html','');});
80
<div id="doc-content">
81
<!-- window showing the filter options -->
82
<div id="MSearchSelectWindow"
83
onmouseover="return searchBox.OnSearchSelectShow()"
84
onmouseout="return searchBox.OnSearchSelectHide()"
85
onkeydown="return searchBox.OnSearchSelectKey(event)">
86
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
88
<!-- iframe showing the search results (closed by default) -->
89
<div id="MSearchResultsWindow">
90
<iframe src="javascript:void(0)" frameborder="0"
91
name="MSearchResults" id="MSearchResults">
39
95
<div class="header">
40
96
<div class="summary">
41
97
<a href="#pub-attribs">Data Fields</a> </div>
42
98
<div class="headertitle">
43
99
<div class="title">surf_action Struct Reference<div class="ingroups"><a class="el" href="group__SURF__actions.html">SURF actions</a></div></div> </div>
45
101
<div class="contents">
46
<!-- doxytag: class="surf_action" -->
47
103
<p>Action structure.
48
104
<a href="structsurf__action.html#details">More...</a></p>
50
106
<p><code>#include <surf.h></code></p>
51
107
<table class="memberdecls">
52
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
108
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
53
109
Data Fields</h2></td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a240981003cb7b2ef07b822b07a3e9973">cost</a></td></tr>
55
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ad856ef7cb77971a29ce0691b52bfd89e">priority</a></td></tr>
56
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab18a20606e4b5393b305f7b0e5ca8fbf">max_duration</a></td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a524498b274bd63b350e368a57105f47f">remains</a></td></tr>
58
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab81d9f768089a74b58910ad81f50d5f7">start</a></td></tr>
59
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a4999b0d857d5e2e56431de7308909fbb">finish</a></td></tr>
60
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a0f6bd3843542d60168febd743a659c6b">data</a></td></tr>
61
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ad4acecd52a2d4699e5f2145225fc890d">category</a></td></tr>
62
<tr><td class="memItemLeft" align="right" valign="top">surf_file_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#aa9ca06fd7e5854befa6036abda2365b4">file</a></td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top">s_file_stat_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab8bdf1c1badb49555ac0d1c327c4bc3a">stat</a></td></tr>
110
<tr class="memitem:a240981003cb7b2ef07b822b07a3e9973"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a240981003cb7b2ef07b822b07a3e9973">cost</a></td></tr>
111
<tr class="memitem:ad856ef7cb77971a29ce0691b52bfd89e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ad856ef7cb77971a29ce0691b52bfd89e">priority</a></td></tr>
112
<tr class="memitem:ab18a20606e4b5393b305f7b0e5ca8fbf"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab18a20606e4b5393b305f7b0e5ca8fbf">max_duration</a></td></tr>
113
<tr class="memitem:a524498b274bd63b350e368a57105f47f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a524498b274bd63b350e368a57105f47f">remains</a></td></tr>
114
<tr class="memitem:ab81d9f768089a74b58910ad81f50d5f7"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab81d9f768089a74b58910ad81f50d5f7">start</a></td></tr>
115
<tr class="memitem:a4999b0d857d5e2e56431de7308909fbb"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a4999b0d857d5e2e56431de7308909fbb">finish</a></td></tr>
116
<tr class="memitem:a0f6bd3843542d60168febd743a659c6b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#a0f6bd3843542d60168febd743a659c6b">data</a></td></tr>
117
<tr class="memitem:ad4acecd52a2d4699e5f2145225fc890d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ad4acecd52a2d4699e5f2145225fc890d">category</a></td></tr>
118
<tr class="memitem:aa9ca06fd7e5854befa6036abda2365b4"><td class="memItemLeft" align="right" valign="top">surf_file_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#aa9ca06fd7e5854befa6036abda2365b4">file</a></td></tr>
119
<tr class="memitem:ab8bdf1c1badb49555ac0d1c327c4bc3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__msg__file__management.html#ga477ef283ddcf854d0252594b60afc236">s_file_stat_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsurf__action.html#ab8bdf1c1badb49555ac0d1c327c4bc3a">stat</a></td></tr>
65
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
121
<a name="details" id="details"></a><h2>Detailed Description</h2>
66
122
<div class="textblock"><p>Action structure. </p>
67
123
<p>Never create s_surf_action_t by yourself ! The actions are created on the fly when you call execute or communicate on a model.</p>
68
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__SURF__actions.html#gab9ef4042b1b038be1b792366de0121b2" title="Action states.">e_surf_action_state_t</a> </dd></dl>
69
</div><hr/><h2>Field Documentation</h2>
70
<a class="anchor" id="a240981003cb7b2ef07b822b07a3e9973"></a><!-- doxytag: member="surf_action::cost" ref="a240981003cb7b2ef07b822b07a3e9973" args="" -->
124
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__SURF__actions.html#gab9ef4042b1b038be1b792366de0121b2" title="Action states.">e_surf_action_state_t</a> </dd></dl>
125
</div><h2>Field Documentation</h2>
126
<a class="anchor" id="a240981003cb7b2ef07b822b07a3e9973"></a>
71
127
<div class="memitem">
72
128
<div class="memproto">
73
129
<table class="memname">
75
<td class="memname">double <a class="el" href="structsurf__action.html#a240981003cb7b2ef07b822b07a3e9973">surf_action::cost</a></td>
131
<td class="memname">double surf_action::cost</td>
134
</div><div class="memdoc">
84
<a class="anchor" id="ad856ef7cb77971a29ce0691b52bfd89e"></a><!-- doxytag: member="surf_action::priority" ref="ad856ef7cb77971a29ce0691b52bfd89e" args="" -->
139
<a class="anchor" id="ad856ef7cb77971a29ce0691b52bfd89e"></a>
85
140
<div class="memitem">
86
141
<div class="memproto">
87
142
<table class="memname">
89
<td class="memname">double <a class="el" href="structsurf__action.html#ad856ef7cb77971a29ce0691b52bfd89e">surf_action::priority</a></td>
144
<td class="memname">double surf_action::priority</td>
147
</div><div class="memdoc">
94
148
<p>priority (1.0 by default) </p>
98
<a class="anchor" id="ab18a20606e4b5393b305f7b0e5ca8fbf"></a><!-- doxytag: member="surf_action::max_duration" ref="ab18a20606e4b5393b305f7b0e5ca8fbf" args="" -->
152
<a class="anchor" id="ab18a20606e4b5393b305f7b0e5ca8fbf"></a>
99
153
<div class="memitem">
100
154
<div class="memproto">
101
155
<table class="memname">
103
<td class="memname">double <a class="el" href="structsurf__action.html#ab18a20606e4b5393b305f7b0e5ca8fbf">surf_action::max_duration</a></td>
157
<td class="memname">double surf_action::max_duration</td>
160
</div><div class="memdoc">
108
161
<p>max_duration (may fluctuate until the task is completed) </p>
112
<a class="anchor" id="a524498b274bd63b350e368a57105f47f"></a><!-- doxytag: member="surf_action::remains" ref="a524498b274bd63b350e368a57105f47f" args="" -->
165
<a class="anchor" id="a524498b274bd63b350e368a57105f47f"></a>
113
166
<div class="memitem">
114
167
<div class="memproto">
115
168
<table class="memname">
117
<td class="memname">double <a class="el" href="structsurf__action.html#a524498b274bd63b350e368a57105f47f">surf_action::remains</a></td>
170
<td class="memname">double surf_action::remains</td>
173
</div><div class="memdoc">
122
174
<p>How much of that cost remains to be done in the currently running task </p>
126
<a class="anchor" id="ab81d9f768089a74b58910ad81f50d5f7"></a><!-- doxytag: member="surf_action::start" ref="ab81d9f768089a74b58910ad81f50d5f7" args="" -->
178
<a class="anchor" id="ab81d9f768089a74b58910ad81f50d5f7"></a>
127
179
<div class="memitem">
128
180
<div class="memproto">
129
181
<table class="memname">
131
<td class="memname">double <a class="el" href="structsurf__action.html#ab81d9f768089a74b58910ad81f50d5f7">surf_action::start</a></td>
183
<td class="memname">double surf_action::start</td>
186
</div><div class="memdoc">
136
187
<p>start time </p>
140
<a class="anchor" id="a4999b0d857d5e2e56431de7308909fbb"></a><!-- doxytag: member="surf_action::finish" ref="a4999b0d857d5e2e56431de7308909fbb" args="" -->
191
<a class="anchor" id="a4999b0d857d5e2e56431de7308909fbb"></a>
141
192
<div class="memitem">
142
193
<div class="memproto">
143
194
<table class="memname">
145
<td class="memname">double <a class="el" href="structsurf__action.html#a4999b0d857d5e2e56431de7308909fbb">surf_action::finish</a></td>
196
<td class="memname">double surf_action::finish</td>
199
</div><div class="memdoc">
150
200
<p>finish time : this is modified during the run and fluctuates until the task is completed </p>
154
<a class="anchor" id="a0f6bd3843542d60168febd743a659c6b"></a><!-- doxytag: member="surf_action::data" ref="a0f6bd3843542d60168febd743a659c6b" args="" -->
204
<a class="anchor" id="a0f6bd3843542d60168febd743a659c6b"></a>
155
205
<div class="memitem">
156
206
<div class="memproto">
157
207
<table class="memname">
159
<td class="memname">void* <a class="el" href="structsurf__action.html#a0f6bd3843542d60168febd743a659c6b">surf_action::data</a></td>
209
<td class="memname">void* surf_action::data</td>
212
</div><div class="memdoc">
164
213
<p>for your convenience </p>
168
<a class="anchor" id="ad4acecd52a2d4699e5f2145225fc890d"></a><!-- doxytag: member="surf_action::category" ref="ad4acecd52a2d4699e5f2145225fc890d" args="" -->
217
<a class="anchor" id="ad4acecd52a2d4699e5f2145225fc890d"></a>
169
218
<div class="memitem">
170
219
<div class="memproto">
171
220
<table class="memname">
173
<td class="memname">char* <a class="el" href="structsurf__action.html#ad4acecd52a2d4699e5f2145225fc890d">surf_action::category</a></td>
222
<td class="memname">char* surf_action::category</td>
225
</div><div class="memdoc">
178
226
<p>tracing category for categorized resource utilization monitoring </p>
182
<a class="anchor" id="aa9ca06fd7e5854befa6036abda2365b4"></a><!-- doxytag: member="surf_action::file" ref="aa9ca06fd7e5854befa6036abda2365b4" args="" -->
230
<a class="anchor" id="aa9ca06fd7e5854befa6036abda2365b4"></a>
183
231
<div class="memitem">
184
232
<div class="memproto">
185
233
<table class="memname">
187
<td class="memname">surf_file_t <a class="el" href="structsurf__action.html#aa9ca06fd7e5854befa6036abda2365b4">surf_action::file</a></td>
235
<td class="memname">surf_file_t surf_action::file</td>
238
</div><div class="memdoc">
192
239
<p>surf_file_t for storage model </p>
196
<a class="anchor" id="ab8bdf1c1badb49555ac0d1c327c4bc3a"></a><!-- doxytag: member="surf_action::stat" ref="ab8bdf1c1badb49555ac0d1c327c4bc3a" args="" -->
243
<a class="anchor" id="ab8bdf1c1badb49555ac0d1c327c4bc3a"></a>
197
244
<div class="memitem">
198
245
<div class="memproto">
199
246
<table class="memname">
201
<td class="memname">s_file_stat_t <a class="el" href="structsurf__action.html#ab8bdf1c1badb49555ac0d1c327c4bc3a">surf_action::stat</a></td>
248
<td class="memname"><a class="el" href="group__msg__file__management.html#ga477ef283ddcf854d0252594b60afc236">s_file_stat_t</a> surf_action::stat</td>
251
</div><div class="memdoc">
206
252
<p>surf_file_t for storage model </p>