Files
ortools-clone/docs/cpp/status__macros_8h.html
Mizux Seiha 17edcf0e25 Update doc
2021-09-30 01:28:18 +02:00

290 lines
14 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!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.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: status_macros.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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.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="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('status__macros_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="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">status_macros.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="status__macros_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 id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceabsl"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceabsl.html">absl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:acdc223d8c59d5c591dc6b4e88257627b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a>(expr)</td></tr>
<tr class="separator:acdc223d8c59d5c591dc6b4e88257627b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade3b99b542ec8f9cd84e438fb3759929"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="status__macros_8h.html#ade3b99b542ec8f9cd84e438fb3759929">STATUS_MACROS_CONCAT_NAME_INNER</a>(x, y)&#160;&#160;&#160;x##y</td></tr>
<tr class="separator:ade3b99b542ec8f9cd84e438fb3759929"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfa1b5068b2bb4dcfd48879d7af43e21"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="status__macros_8h.html#adfa1b5068b2bb4dcfd48879d7af43e21">STATUS_MACROS_CONCAT_NAME</a>(x, y)&#160;&#160;&#160;<a class="el" href="status__macros_8h.html#ade3b99b542ec8f9cd84e438fb3759929">STATUS_MACROS_CONCAT_NAME_INNER</a>(x, y)</td></tr>
<tr class="separator:adfa1b5068b2bb4dcfd48879d7af43e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16417602e4b60ded651e08cdf62a73c4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="status__macros_8h.html#a16417602e4b60ded651e08cdf62a73c4">ASSIGN_OR_RETURN_IMPL</a>(statusor, lhs, rexpr)</td></tr>
<tr class="separator:a16417602e4b60ded651e08cdf62a73c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a600de4b8f65fe0a4b1898041634f9011"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="status__macros_8h.html#a600de4b8f65fe0a4b1898041634f9011">ASSIGN_OR_RETURN</a>(lhs, rexpr)</td></tr>
<tr class="separator:a600de4b8f65fe0a4b1898041634f9011"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a600de4b8f65fe0a4b1898041634f9011" name="a600de4b8f65fe0a4b1898041634f9011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a600de4b8f65fe0a4b1898041634f9011">&#9670;&nbsp;</a></span>ASSIGN_OR_RETURN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ASSIGN_OR_RETURN</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</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 hl_define" href="status__macros_8h.html#a16417602e4b60ded651e08cdf62a73c4">ASSIGN_OR_RETURN_IMPL</a>( \</div>
<div class="line"> <a class="code hl_define" href="status__macros_8h.html#adfa1b5068b2bb4dcfd48879d7af43e21">STATUS_MACROS_CONCAT_NAME</a>(_status_or_value, __COUNTER__), lhs, rexpr);</div>
<div class="ttc" id="astatus__macros_8h_html_a16417602e4b60ded651e08cdf62a73c4"><div class="ttname"><a href="status__macros_8h.html#a16417602e4b60ded651e08cdf62a73c4">ASSIGN_OR_RETURN_IMPL</a></div><div class="ttdeci">#define ASSIGN_OR_RETURN_IMPL(statusor, lhs, rexpr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00041">status_macros.h:41</a></div></div>
<div class="ttc" id="astatus__macros_8h_html_adfa1b5068b2bb4dcfd48879d7af43e21"><div class="ttname"><a href="status__macros_8h.html#adfa1b5068b2bb4dcfd48879d7af43e21">STATUS_MACROS_CONCAT_NAME</a></div><div class="ttdeci">#define STATUS_MACROS_CONCAT_NAME(x, y)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00039">status_macros.h:39</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="status__macros_8h_source.html#l00055">55</a> of file <a class="el" href="status__macros_8h_source.html">status_macros.h</a>.</p>
</div>
</div>
<a id="a16417602e4b60ded651e08cdf62a73c4" name="a16417602e4b60ded651e08cdf62a73c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16417602e4b60ded651e08cdf62a73c4">&#9670;&nbsp;</a></span>ASSIGN_OR_RETURN_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ASSIGN_OR_RETURN_IMPL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">statusor, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</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="keyword">auto</span> statusor = (rexpr); \</div>
<div class="line"> RETURN_IF_ERROR(statusor.status()); \</div>
<div class="line"> lhs = *std::move(statusor)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="status__macros_8h_source.html#l00041">41</a> of file <a class="el" href="status__macros_8h_source.html">status_macros.h</a>.</p>
</div>
</div>
<a id="acdc223d8c59d5c591dc6b4e88257627b" name="acdc223d8c59d5c591dc6b4e88257627b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdc223d8c59d5c591dc6b4e88257627b">&#9670;&nbsp;</a></span>RETURN_IF_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_IF_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">switch</span> (0) \</div>
<div class="line"> case 0: \</div>
<div class="line"> default: \</div>
<div class="line"> if (const ::absl::Status status = (expr); status.ok()) { \</div>
<div class="line"> } <span class="keywordflow">else</span> <span class="comment">/* NOLINT */</span> \</div>
<div class="line"> return ::util::StatusBuilder(status)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="status__macros_8h_source.html#l00029">29</a> of file <a class="el" href="status__macros_8h_source.html">status_macros.h</a>.</p>
</div>
</div>
<a id="adfa1b5068b2bb4dcfd48879d7af43e21" name="adfa1b5068b2bb4dcfd48879d7af43e21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfa1b5068b2bb4dcfd48879d7af43e21">&#9670;&nbsp;</a></span>STATUS_MACROS_CONCAT_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STATUS_MACROS_CONCAT_NAME</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">y&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="status__macros_8h.html#ade3b99b542ec8f9cd84e438fb3759929">STATUS_MACROS_CONCAT_NAME_INNER</a>(x, y)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="status__macros_8h_source.html#l00039">39</a> of file <a class="el" href="status__macros_8h_source.html">status_macros.h</a>.</p>
</div>
</div>
<a id="ade3b99b542ec8f9cd84e438fb3759929" name="ade3b99b542ec8f9cd84e438fb3759929"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade3b99b542ec8f9cd84e438fb3759929">&#9670;&nbsp;</a></span>STATUS_MACROS_CONCAT_NAME_INNER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STATUS_MACROS_CONCAT_NAME_INNER</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">y&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;x##y</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="status__macros_8h_source.html#l00038">38</a> of file <a class="el" href="status__macros_8h_source.html">status_macros.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="status__macros_8h.html">status_macros.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>