256 lines
13 KiB
HTML
256 lines
13 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: CppBridge</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.2</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('classoperations__research_1_1_cpp_bridge.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="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classoperations__research_1_1_cpp_bridge-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">CppBridge</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >This class performs various C++ initialization. </p>
|
|
<p >It is meant to be used once at the start of a program. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="init_8h_source.html#l00082">82</a> of file <a class="el" href="init_8h_source.html">init.h</a>.</p>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0791cbe09f25845c34a6cb31e7d2684c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_cpp_bridge.html#a0791cbe09f25845c34a6cb31e7d2684c">InitLogging</a> (const std::string &program_name)</td></tr>
|
|
<tr class="memdesc:a0791cbe09f25845c34a6cb31e7d2684c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the C++ logging layer. <a href="classoperations__research_1_1_cpp_bridge.html#a0791cbe09f25845c34a6cb31e7d2684c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0791cbe09f25845c34a6cb31e7d2684c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64e59c5358ea027ab02e56eeec473c6a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_cpp_bridge.html#a64e59c5358ea027ab02e56eeec473c6a">ShutdownLogging</a> ()</td></tr>
|
|
<tr class="memdesc:a64e59c5358ea027ab02e56eeec473c6a"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the C++ logging layer. <a href="classoperations__research_1_1_cpp_bridge.html#a64e59c5358ea027ab02e56eeec473c6a">More...</a><br /></td></tr>
|
|
<tr class="separator:a64e59c5358ea027ab02e56eeec473c6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9103ba21c4acec1b91f3bbdc0b487ed0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_cpp_bridge.html#a9103ba21c4acec1b91f3bbdc0b487ed0">SetFlags</a> (const <a class="el" href="structoperations__research_1_1_cpp_flags.html">CppFlags</a> &flags)</td></tr>
|
|
<tr class="memdesc:a9103ba21c4acec1b91f3bbdc0b487ed0"><td class="mdescLeft"> </td><td class="mdescRight">Sets all the C++ flags contained in the <a class="el" href="structoperations__research_1_1_cpp_flags.html" title="Simple structure that holds useful C++ flags to setup from non-C++ languages.">CppFlags</a> structure. <a href="classoperations__research_1_1_cpp_bridge.html#a9103ba21c4acec1b91f3bbdc0b487ed0">More...</a><br /></td></tr>
|
|
<tr class="separator:a9103ba21c4acec1b91f3bbdc0b487ed0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c72fce46a300530616abdaf06de074a"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_cpp_bridge.html#a5c72fce46a300530616abdaf06de074a">LoadGurobiSharedLibrary</a> (const std::string &full_library_path)</td></tr>
|
|
<tr class="memdesc:a5c72fce46a300530616abdaf06de074a"><td class="mdescLeft"> </td><td class="mdescRight">Load the gurobi shared library. <a href="classoperations__research_1_1_cpp_bridge.html#a5c72fce46a300530616abdaf06de074a">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c72fce46a300530616abdaf06de074a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a0791cbe09f25845c34a6cb31e7d2684c" name="a0791cbe09f25845c34a6cb31e7d2684c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0791cbe09f25845c34a6cb31e7d2684c">◆ </a></span>InitLogging()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void InitLogging </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>program_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize the C++ logging layer. </p>
|
|
<p >This must be called once before any other library from OR-Tools are used. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="init_8h_source.html#l00089">89</a> of file <a class="el" href="init_8h_source.html">init.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c72fce46a300530616abdaf06de074a" name="a5c72fce46a300530616abdaf06de074a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c72fce46a300530616abdaf06de074a">◆ </a></span>LoadGurobiSharedLibrary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool LoadGurobiSharedLibrary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>full_library_path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Load the gurobi shared library. </p>
|
|
<p >This is necessary if the library is installed in a non canonical directory, or if for any reason, it is not found. You need to pass the full path, including the shared library file. It returns true if the library was found and correctly loaded. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="init_8h_source.html#l00123">123</a> of file <a class="el" href="init_8h_source.html">init.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9103ba21c4acec1b91f3bbdc0b487ed0" name="a9103ba21c4acec1b91f3bbdc0b487ed0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9103ba21c4acec1b91f3bbdc0b487ed0">◆ </a></span>SetFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void SetFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structoperations__research_1_1_cpp_flags.html">CppFlags</a> & </td>
|
|
<td class="paramname"><em>flags</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets all the C++ flags contained in the <a class="el" href="structoperations__research_1_1_cpp_flags.html" title="Simple structure that holds useful C++ flags to setup from non-C++ languages.">CppFlags</a> structure. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="init_8h_source.html#l00104">104</a> of file <a class="el" href="init_8h_source.html">init.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a64e59c5358ea027ab02e56eeec473c6a" name="a64e59c5358ea027ab02e56eeec473c6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a64e59c5358ea027ab02e56eeec473c6a">◆ </a></span>ShutdownLogging()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void ShutdownLogging </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Shutdown the C++ logging layer. </p>
|
|
<p >This can be called to shutdown the C++ logging layer from OR-Tools. It should only be called once. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="init_8h_source.html#l00099">99</a> of file <a class="el" href="init_8h_source.html">init.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="init_8h_source.html">init.h</a></li>
|
|
</ul>
|
|
</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="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1_cpp_bridge.html">CppBridge</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>
|