Files
ortools-clone/docs/cpp/status_8cc_source.html
Mizux Seiha 3b7ffd12b0 Update doc
2020-10-09 12:01:52 +02:00

166 lines
17 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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: status.cc Source File</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">8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('status_8cc_source.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="headertitle">
<div class="title">status.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="status_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2010-2018 Google LLC</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="status_8h.html">ortools/glop/status.h</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span>glop {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classoperations__research_1_1glop_1_1_status.html#aafde58df1b2a6a91d5b674373be3ffc5"> 23</a></span>&#160;<a class="code" href="classoperations__research_1_1glop_1_1_status.html#aafde58df1b2a6a91d5b674373be3ffc5">Status::Status</a>() : error_code_(GLOP_OK), error_message_() {}</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classoperations__research_1_1glop_1_1_status.html#a7ea81d0dfbf92b0d36c8f34430d5f793"> 25</a></span>&#160;<a class="code" href="classoperations__research_1_1glop_1_1_status.html#aafde58df1b2a6a91d5b674373be3ffc5">Status::Status</a>(<a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05f">ErrorCode</a> error_code, std::string error_message)</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; : error_code_(error_code),</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; error_message_(error_code == GLOP_OK ? <span class="stringliteral">&quot;&quot;</span> : std::move(error_message)) {}</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1glop.html#a872df76d3d034d6a75a88ba6c9d8ac4c"> 29</a></span>&#160;std::string <a class="code" href="namespaceoperations__research_1_1glop.html#a872df76d3d034d6a75a88ba6c9d8ac4c">GetErrorCodeString</a>(<a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05f">Status::ErrorCode</a> error_code) {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">switch</span> (error_code) {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05faa8b9097bb2258da695d1540d2643708f">Status::GLOP_OK</a>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;GLOP_OK&quot;</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fafa2ff9c081445bfbfbda10bc41b76a87">Status::ERROR_LU</a>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;ERROR_LU&quot;</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fac6a90d8a1d99fabc7b9223c5319313f8">Status::ERROR_BOUND</a>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;ERROR_BOUND&quot;</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fad1dad808eef93fe211f2f63327e805b2">Status::ERROR_NULL</a>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;ERROR_NULL&quot;</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fa79a0e04dceac3db90cc878d11c6cfa55">Status::ERROR_INVALID_PROBLEM</a>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;INVALID_PROBLEM&quot;</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// Fallback. We don&#39;t use &quot;default:&quot; so the compiler will return an error</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// if we forgot one enum case above.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; LOG(DFATAL) &lt;&lt; <span class="stringliteral">&quot;Invalid Status::ErrorCode &quot;</span> &lt;&lt; error_code;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;UNKNOWN Status::ErrorCode&quot;</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;} <span class="comment">// namespace glop</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;} <span class="comment">// namespace operations_research</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05faa8b9097bb2258da695d1540d2643708f"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05faa8b9097bb2258da695d1540d2643708f">operations_research::glop::Status::GLOP_OK</a></div><div class="ttdeci">@ GLOP_OK</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00029">status.h:29</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05fa79a0e04dceac3db90cc878d11c6cfa55"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fa79a0e04dceac3db90cc878d11c6cfa55">operations_research::glop::Status::ERROR_INVALID_PROBLEM</a></div><div class="ttdeci">@ ERROR_INVALID_PROBLEM</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00041">status.h:41</a></div></div>
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">The vehicle routing library lets one model and solve generic vehicle routing problems ranging from th...</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</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="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05fafa2ff9c081445bfbfbda10bc41b76a87"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fafa2ff9c081445bfbfbda10bc41b76a87">operations_research::glop::Status::ERROR_LU</a></div><div class="ttdeci">@ ERROR_LU</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00032">status.h:32</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_aafde58df1b2a6a91d5b674373be3ffc5"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#aafde58df1b2a6a91d5b674373be3ffc5">operations_research::glop::Status::Status</a></div><div class="ttdeci">Status()</div><div class="ttdef"><b>Definition:</b> <a href="status_8cc_source.html#l00023">status.cc:23</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05fac6a90d8a1d99fabc7b9223c5319313f8"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fac6a90d8a1d99fabc7b9223c5319313f8">operations_research::glop::Status::ERROR_BOUND</a></div><div class="ttdeci">@ ERROR_BOUND</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00035">status.h:35</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05f"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05f">operations_research::glop::Status::ErrorCode</a></div><div class="ttdeci">ErrorCode</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00027">status.h:27</a></div></div>
<div class="ttc" id="astatus_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1glop_1_1_status_html_a59e56af19e754a6aa26a612ebf91d05fad1dad808eef93fe211f2f63327e805b2"><div class="ttname"><a href="classoperations__research_1_1glop_1_1_status.html#a59e56af19e754a6aa26a612ebf91d05fad1dad808eef93fe211f2f63327e805b2">operations_research::glop::Status::ERROR_NULL</a></div><div class="ttdeci">@ ERROR_NULL</div><div class="ttdef"><b>Definition:</b> <a href="status_8h_source.html#l00038">status.h:38</a></div></div>
<!-- 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_8cc.html">status.cc</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.8.20 </li>
</ul>
</div>
</body>
</html>