-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathapi__status_8h.html
More file actions
358 lines (347 loc) · 25.9 KB
/
api__status_8h.html
File metadata and controls
358 lines (347 loc) · 25.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Reinforcement Learning: /home/runner/work/reinforcement_learning/reinforcement_learning/include/api_status.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Reinforcement Learning
 <span id="projectnumber">1.1</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('api__status_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">api_status.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>api_status definition. api_status is used to return error information to the caller. (<a class="el" href="api_error_codes.html">API Error Codes</a>)
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="err__constants_8h_source.html">err_constants.h</a>"</code><br />
<code>#include <sstream></code><br />
<code>#include <string></code><br />
</div>
<p><a href="api__status_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classreinforcement__learning_1_1api__status.html">reinforcement_learning::api_status</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Report status of all API calls. <a href="classreinforcement__learning_1_1api__status.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structreinforcement__learning_1_1status__builder.html">reinforcement_learning::status_builder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class used in report_error template funcstions to return status from API calls. <a href="structreinforcement__learning_1_1status__builder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacereinforcement__learning"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html">reinforcement_learning</a></td></tr>
<tr class="memdesc:namespacereinforcement__learning"><td class="mdescLeft"> </td><td class="mdescRight">[Error Generator] <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a51b23c54eef2576e2c4eec94bb6a8cad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api__status_8h.html#a51b23c54eef2576e2c4eec94bb6a8cad">RETURN_ERROR</a>(trace, status, code, ...)</td></tr>
<tr class="memdesc:a51b23c54eef2576e2c4eec94bb6a8cad"><td class="mdescLeft"> </td><td class="mdescRight">Error reporting macro for just returning an error code. <a href="api__status_8h.html#a51b23c54eef2576e2c4eec94bb6a8cad">More...</a><br /></td></tr>
<tr class="separator:a51b23c54eef2576e2c4eec94bb6a8cad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ac9ce264224243c932dcfccb4c37507"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api__status_8h.html#a5ac9ce264224243c932dcfccb4c37507">RETURN_ERROR_ARG</a>(trace, status, code, ...)</td></tr>
<tr class="memdesc:a5ac9ce264224243c932dcfccb4c37507"><td class="mdescLeft"> </td><td class="mdescRight">Error reporting macro that takes a list of parameters. <a href="api__status_8h.html#a5ac9ce264224243c932dcfccb4c37507">More...</a><br /></td></tr>
<tr class="separator:a5ac9ce264224243c932dcfccb4c37507"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae53bad0e4f12115d8d210228f0d5c1ae"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api__status_8h.html#ae53bad0e4f12115d8d210228f0d5c1ae">RETURN_ERROR_LS</a>(trace, status, code)</td></tr>
<tr class="memdesc:ae53bad0e4f12115d8d210228f0d5c1ae"><td class="mdescLeft"> </td><td class="mdescRight">Error reporting macro used with left shift operator. <a href="api__status_8h.html#ae53bad0e4f12115d8d210228f0d5c1ae">More...</a><br /></td></tr>
<tr class="separator:ae53bad0e4f12115d8d210228f0d5c1ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11385635c23358843d733b2e6f3241c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api__status_8h.html#a11385635c23358843d733b2e6f3241c4">RETURN_IF_FAIL</a>(x)</td></tr>
<tr class="memdesc:a11385635c23358843d733b2e6f3241c4"><td class="mdescLeft"> </td><td class="mdescRight">Error reporting macro to test and return on error. <a href="api__status_8h.html#a11385635c23358843d733b2e6f3241c4">More...</a><br /></td></tr>
<tr class="separator:a11385635c23358843d733b2e6f3241c4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afc19d04214c926d3dc7bb2b7a6dcafb1"><td class="memTemplParams" colspan="2">template<typename Last > </td></tr>
<tr class="memitem:afc19d04214c926d3dc7bb2b7a6dcafb1"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#afc19d04214c926d3dc7bb2b7a6dcafb1">reinforcement_learning::report_error</a> (std::ostringstream &oss, const Last &last)</td></tr>
<tr class="memdesc:afc19d04214c926d3dc7bb2b7a6dcafb1"><td class="mdescLeft"> </td><td class="mdescRight">Ends recursion of report_error variadic template with the Last argument. <a href="namespacereinforcement__learning.html#afc19d04214c926d3dc7bb2b7a6dcafb1">More...</a><br /></td></tr>
<tr class="separator:afc19d04214c926d3dc7bb2b7a6dcafb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a482a8f20c0a1a1e371e8d32205428228"><td class="memTemplParams" colspan="2">template<typename First , typename... Rest> </td></tr>
<tr class="memitem:a482a8f20c0a1a1e371e8d32205428228"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#a482a8f20c0a1a1e371e8d32205428228">reinforcement_learning::report_error</a> (std::ostringstream &oss, const First &first, const Rest &... rest)</td></tr>
<tr class="memdesc:a482a8f20c0a1a1e371e8d32205428228"><td class="mdescLeft"> </td><td class="mdescRight">Begins recursion of report_error variadic template with ostringstream to serialize error information. <a href="namespacereinforcement__learning.html#a482a8f20c0a1a1e371e8d32205428228">More...</a><br /></td></tr>
<tr class="separator:a482a8f20c0a1a1e371e8d32205428228"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a7c7e398b69d8a9caff1ab2e11653cb"><td class="memTemplParams" colspan="2">template<typename... All> </td></tr>
<tr class="memitem:a5a7c7e398b69d8a9caff1ab2e11653cb"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#a5a7c7e398b69d8a9caff1ab2e11653cb">reinforcement_learning::report_error</a> (api_status *status, int scode, const All &... all)</td></tr>
<tr class="memdesc:a5a7c7e398b69d8a9caff1ab2e11653cb"><td class="mdescLeft"> </td><td class="mdescRight">The main report_error template used to serialize error into <a class="el" href="classreinforcement__learning_1_1api__status.html" title="Report status of all API calls.">api_status</a> The method most end users will use with a status code and a number of objects to be serialised into an <a class="el" href="classreinforcement__learning_1_1api__status.html" title="Report status of all API calls.">api_status</a>. <a href="namespacereinforcement__learning.html#a5a7c7e398b69d8a9caff1ab2e11653cb">More...</a><br /></td></tr>
<tr class="separator:a5a7c7e398b69d8a9caff1ab2e11653cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae816c7c9d77fb9ce1aa358cd2958439"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:aae816c7c9d77fb9ce1aa358cd2958439"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structreinforcement__learning_1_1status__builder.html">reinforcement_learning::status_builder</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#aae816c7c9d77fb9ce1aa358cd2958439">reinforcement_learning::operator<<</a> (<a class="el" href="structreinforcement__learning_1_1status__builder.html">reinforcement_learning::status_builder</a> &sbuilder, const T &val)</td></tr>
<tr class="memdesc:aae816c7c9d77fb9ce1aa358cd2958439"><td class="mdescLeft"> </td><td class="mdescRight">left shift operator to serialize types into stringstream held in <a class="el" href="structreinforcement__learning_1_1status__builder.html" title="Helper class used in report_error template funcstions to return status from API calls.">status_builder</a> <a href="namespacereinforcement__learning.html#aae816c7c9d77fb9ce1aa358cd2958439">More...</a><br /></td></tr>
<tr class="separator:aae816c7c9d77fb9ce1aa358cd2958439"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0dd2105552e59675ceb4b0f609da2089"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#a0dd2105552e59675ceb4b0f609da2089">reinforcement_learning::report_error</a> (status_builder &sbuilder)</td></tr>
<tr class="memdesc:a0dd2105552e59675ceb4b0f609da2089"><td class="mdescLeft"> </td><td class="mdescRight">Terminates recursion of report_error. <a href="namespacereinforcement__learning.html#a0dd2105552e59675ceb4b0f609da2089">More...</a><br /></td></tr>
<tr class="separator:a0dd2105552e59675ceb4b0f609da2089"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85145b1408e4e2546954d6579029295e"><td class="memTemplParams" colspan="2">template<typename Last > </td></tr>
<tr class="memitem:a85145b1408e4e2546954d6579029295e"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#a85145b1408e4e2546954d6579029295e">reinforcement_learning::report_error</a> (status_builder &sbuilder, const Last &last)</td></tr>
<tr class="memdesc:a85145b1408e4e2546954d6579029295e"><td class="mdescLeft"> </td><td class="mdescRight">report_error that takes the final paramter <a href="namespacereinforcement__learning.html#a85145b1408e4e2546954d6579029295e">More...</a><br /></td></tr>
<tr class="separator:a85145b1408e4e2546954d6579029295e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc3d282d1eebc79213d2075d3ce845cd"><td class="memTemplParams" colspan="2">template<typename First , typename... Rest> </td></tr>
<tr class="memitem:abc3d282d1eebc79213d2075d3ce845cd"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacereinforcement__learning.html#abc3d282d1eebc79213d2075d3ce845cd">reinforcement_learning::report_error</a> (status_builder &sbuilder, const First &first, const Rest &... rest)</td></tr>
<tr class="memdesc:abc3d282d1eebc79213d2075d3ce845cd"><td class="mdescLeft"> </td><td class="mdescRight">variadic template report_error that takes a list of parameters <a href="namespacereinforcement__learning.html#abc3d282d1eebc79213d2075d3ce845cd">More...</a><br /></td></tr>
<tr class="separator:abc3d282d1eebc79213d2075d3ce845cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>api_status definition. api_status is used to return error information to the caller. (<a class="el" href="api_error_codes.html">API Error Codes</a>) </p>
<dl class="section author"><dt>Author</dt><dd>Rajan Chari et al </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2018-07-18 </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a51b23c54eef2576e2c4eec94bb6a8cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51b23c54eef2576e2c4eec94bb6a8cad">◆ </a></span>RETURN_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_ERROR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trace, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">status, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">code, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (status != <span class="keyword">nullptr</span>) \</div>
<div class="line"> { \</div>
<div class="line"> reinforcement_learning::status_builder sbuilder(trace, status, reinforcement_learning::error_code::code); \</div>
<div class="line"> sbuilder << reinforcement_learning::error_code::code##_s; \</div>
<div class="line"> return <a class="code" href="namespacereinforcement__learning.html#abc3d282d1eebc79213d2075d3ce845cd">report_error</a>(sbuilder); \</div>
<div class="line"> } \</div>
<div class="line"> return reinforcement_learning::error_code::code; \</div>
<div class="line"> } <span class="keywordflow">while</span> (0);</div>
<div class="ttc" id="anamespacereinforcement__learning_html_abc3d282d1eebc79213d2075d3ce845cd"><div class="ttname"><a href="namespacereinforcement__learning.html#abc3d282d1eebc79213d2075d3ce845cd">reinforcement_learning::report_error</a></div><div class="ttdeci">int report_error(status_builder &sbuilder, const First &first, const Rest &... rest)</div><div class="ttdoc">variadic template report_error that takes a list of parameters</div><div class="ttdef"><b>Definition:</b> api_status.h:199</div></div>
</div><!-- fragment -->
<p>Error reporting macro for just returning an error code. </p>
</div>
</div>
<a id="a5ac9ce264224243c932dcfccb4c37507"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ac9ce264224243c932dcfccb4c37507">◆ </a></span>RETURN_ERROR_ARG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_ERROR_ARG</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trace, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">status, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">code, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (status != <span class="keyword">nullptr</span>) \</div>
<div class="line"> { \</div>
<div class="line"> reinforcement_learning::status_builder sbuilder(trace, status, reinforcement_learning::error_code::code); \</div>
<div class="line"> sbuilder << reinforcement_learning::error_code::code##_s; \</div>
<div class="line"> return <a class="code" href="namespacereinforcement__learning.html#abc3d282d1eebc79213d2075d3ce845cd">report_error</a>(sbuilder, __VA_ARGS__); \</div>
<div class="line"> } \</div>
<div class="line"> return reinforcement_learning::error_code::code; \</div>
<div class="line"> } <span class="keywordflow">while</span> (0);</div>
</div><!-- fragment -->
<p>Error reporting macro that takes a list of parameters. </p>
</div>
</div>
<a id="ae53bad0e4f12115d8d210228f0d5c1ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae53bad0e4f12115d8d210228f0d5c1ae">◆ </a></span>RETURN_ERROR_LS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_ERROR_LS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trace, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">status, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">code </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="structreinforcement__learning_1_1status__builder.html">reinforcement_learning::status_builder</a> sbuilder(trace, status, reinforcement_learning::error_code::code); \</div>
<div class="line"> return sbuilder << reinforcement_learning::error_code::code##_s</div>
<div class="ttc" id="astructreinforcement__learning_1_1status__builder_html"><div class="ttname"><a href="structreinforcement__learning_1_1status__builder.html">reinforcement_learning::status_builder</a></div><div class="ttdoc">Helper class used in report_error template funcstions to return status from API calls.</div><div class="ttdef"><b>Definition:</b> api_status.h:67</div></div>
</div><!-- fragment -->
<p>Error reporting macro used with left shift operator. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="rl_sim_8cc-example.html#a2">rl_sim.cc</a>.</dd>
</dl>
</div>
</div>
<a id="a11385635c23358843d733b2e6f3241c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11385635c23358843d733b2e6f3241c4">◆ </a></span>RETURN_IF_FAIL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_IF_FAIL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> int retval__LINE__ = (x); \</div>
<div class="line"> if (retval__LINE__ != 0) { <span class="keywordflow">return</span> retval__LINE__; } \</div>
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment -->
<p>Error reporting macro to test and return on error. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="override_interface_8cc-example.html#a0">override_interface.cc</a>, and <a class="el" href="rl_sim_8cc-example.html#a1">rl_sim.cc</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="api__status_8h.html">api_status.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>