230 lines
14 KiB
HTML
230 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.3"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: 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>
|
|
<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
|
|
 <span id="projectnumber">9.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.3 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('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">status.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="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 id="nested-classes" 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="classoperations__research_1_1glop_1_1_status.html">Status</a></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 id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html">operations_research</a></td></tr>
|
|
<tr class="memdesc:namespaceoperations__research"><td class="mdescLeft"> </td><td class="mdescRight">Collection of objects used to extend the <a class="el" href="classoperations__research_1_1_constraint.html" title="A constraint is the main modeling object.">Constraint</a> <a class="el" href="classoperations__research_1_1_solver.html" title="Solver Class.">Solver</a> library. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:namespaceoperations__research_1_1glop"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1glop.html">operations_research::glop</a></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 id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a3efb1c6250c02a5b881f8b82f75f9822"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="status_8h.html#a3efb1c6250c02a5b881f8b82f75f9822">GLOP_RETURN_IF_ERROR</a>(function_call)</td></tr>
|
|
<tr class="separator:a3efb1c6250c02a5b881f8b82f75f9822"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c76f1eb9790accd2cd0c5fa5c03c322"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="status_8h.html#a8c76f1eb9790accd2cd0c5fa5c03c322">GLOP_RETURN_AND_LOG_ERROR</a>(error_code, <a class="el" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>)</td></tr>
|
|
<tr class="separator:a8c76f1eb9790accd2cd0c5fa5c03c322"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9a90d3e61ffae636234f2c1283117d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="status_8h.html#ae9a90d3e61ffae636234f2c1283117d8">GLOP_RETURN_ERROR_IF_NULL</a>(arg)</td></tr>
|
|
<tr class="separator:ae9a90d3e61ffae636234f2c1283117d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a872df76d3d034d6a75a88ba6c9d8ac4c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1glop.html#a872df76d3d034d6a75a88ba6c9d8ac4c">GetErrorCodeString</a> (Status::ErrorCode error_code)</td></tr>
|
|
<tr class="separator:a872df76d3d034d6a75a88ba6c9d8ac4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a8c76f1eb9790accd2cd0c5fa5c03c322" name="a8c76f1eb9790accd2cd0c5fa5c03c322"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c76f1eb9790accd2cd0c5fa5c03c322">◆ </a></span>GLOP_RETURN_AND_LOG_ERROR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GLOP_RETURN_AND_LOG_ERROR</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">error_code, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><a class="el" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a> </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"> std::string error_message = <a class="code hl_variable" href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a>; \</div>
|
|
<div class="line"> LOG(<a class="code hl_variable" href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a>) << <a class="code hl_function" href="namespaceoperations__research_1_1glop.html#a872df76d3d034d6a75a88ba6c9d8ac4c">GetErrorCodeString</a>(error_code) << <span class="stringliteral">": "</span> << error_message; \</div>
|
|
<div class="line"> return Status(error_code, error_message); \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
|
|
<div class="ttc" id="alog__severity_8h_html_ac9bcbe19995a8140cd4ec61773cd6e67"><div class="ttname"><a href="log__severity_8h.html#ac9bcbe19995a8140cd4ec61773cd6e67">ERROR</a></div><div class="ttdeci">const int ERROR</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00032">log_severity.h:32</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1glop_html_a872df76d3d034d6a75a88ba6c9d8ac4c"><div class="ttname"><a href="namespaceoperations__research_1_1glop.html#a872df76d3d034d6a75a88ba6c9d8ac4c">operations_research::glop::GetErrorCodeString</a></div><div class="ttdeci">std::string GetErrorCodeString(Status::ErrorCode error_code)</div><div class="ttdef"><b>Definition:</b> <a href="status_8cc_source.html#l00029">status.cc:29</a></div></div>
|
|
<div class="ttc" id="atrace_8cc_html_a36bd74109f547f7f8198faf5a12d2879"><div class="ttname"><a href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="trace_8cc_source.html#l00398">trace.cc:398</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00079">79</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9a90d3e61ffae636234f2c1283117d8" name="ae9a90d3e61ffae636234f2c1283117d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9a90d3e61ffae636234f2c1283117d8">◆ </a></span>GLOP_RETURN_ERROR_IF_NULL</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GLOP_RETURN_ERROR_IF_NULL</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">arg</td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span> (arg == <span class="keyword">nullptr</span>) { \</div>
|
|
<div class="line"> const std::string variable_name = #arg; \</div>
|
|
<div class="line"> std::string error_message = variable_name + <span class="stringliteral">" must not be null."</span>; \</div>
|
|
<div class="line"> LOG(DFATAL) << error_message; \</div>
|
|
<div class="line"> return Status(Status::ERROR_NULL, error_message); \</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00087">87</a> of file <a class="el" href="status_8h_source.html">status.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3efb1c6250c02a5b881f8b82f75f9822" name="a3efb1c6250c02a5b881f8b82f75f9822"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3efb1c6250c02a5b881f8b82f75f9822">◆ </a></span>GLOP_RETURN_IF_ERROR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GLOP_RETURN_IF_ERROR</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">function_call</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"> Status return_status = function_call; \</div>
|
|
<div class="line"> if (!return_status.ok()) return return_status; \</div>
|
|
<div class="line"> } while (false)</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="status_8h_source.html#l00072">72</a> of file <a class="el" href="status_8h_source.html">status.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_747248fa8ec2ebcb4d8ad85ced34db0b.html">glop</a></li><li class="navelem"><a class="el" href="status_8h.html">status.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.3 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|