Files
ortools-clone/docs/cpp/gscip__event__handler_8h_source.html

130 lines
44 KiB
HTML
Raw Normal View History

2021-04-27 23:00:03 +02:00
<!-- 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"/>
2021-09-20 15:57:27 +02:00
<meta name="generator" content="Doxygen 1.8.15"/>
2021-04-27 23:00:03 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: gscip_event_handler.h 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>
2021-09-20 15:57:27 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
2021-04-27 23:00:03 +02:00
<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
2021-09-20 15:57:27 +02:00
&#160;<span id="projectnumber">9.1</span>
2021-04-27 23:00:03 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-09-20 15:57:27 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2021-04-27 23:00:03 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-09-20 15:57:27 +02:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2021-04-27 23:00:03 +02:00
/* @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 */
2021-09-20 15:57:27 +02:00
$(document).ready(function(){initNavTree('gscip__event__handler_8h_source.html','');});
2021-04-27 23:00:03 +02:00
/* @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">gscip_event_handler.h</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<a href="gscip__event__handler_8h.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-2021 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="comment">// Provides a safe C++ interface for SCIP event handlers, which are described at</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// https://www.scipopt.org/doc-7.0.1/html/EVENT.php.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#ifndef OR_TOOLS_GSCIP_GSCIP_EVENT_HANDLER_H_</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define OR_TOOLS_GSCIP_GSCIP_EVENT_HANDLER_H_</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="gscip_8h.html">ortools/gscip/gscip.h</a>&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;scip/type_event.h&quot;</span></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"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structop
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_a7b155d3468652f190ee543976e2727b0"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a7b155d3468652f190ee543976e2727b0">operations_research::GScipEventHandler::Exit</a></div><div class="ttdeci">virtual SCIP_RETCODE Exit(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00132">gscip_event_handler.h:132</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_context_html_a5eb99c9b4e60a5098c8c8b25856b58ec"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a5eb99c9b4e60a5098c8c8b25856b58ec">operations_research::GScipEventHandlerContext::gscip</a></div><div class="ttdeci">GScip * gscip() const</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00049">gscip_event_handler.h:49</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip.html">operations_research::GScip</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip_8h_source.html#l00127">gscip.h:127</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_a3db37da33025584bd2f7f9e5eb327316"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a3db37da33025584bd2f7f9e5eb327316">operations_research::GScipEventHandler::Execute</a></div><div class="ttdeci">virtual SCIP_RETCODE Execute(GScipEventHandlerContext context)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00119">gscip_event_handler.h:119</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_a172181c14c0a0d5171384a0377fc2341"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a172181c14c0a0d5171384a0377fc2341">operations_research::GScipEventHandler::~GScipEventHandler</a></div><div class="ttdeci">virtual ~GScipEventHandler()=default</div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_context_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html">operations_research::GScipEventHandlerContext</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00044">gscip_event_handler.h:44</a></div></div>
<div class="ttc" id="structoperations__research_1_1_g_scip_event_handler_description_html"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html">operations_research::GScipEventHandlerDescription</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00027">gscip_event_handler.h:27</a></div></div>
<div class="ttc" id="structoperations__research_1_1_g_scip_event_handler_description_html_a9b45b3e13bd9167aab02e17e08916231"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html#a9b45b3e13bd9167aab02e17e08916231">operations_research::GScipEventHandlerDescription::name</a></div><div class="ttdeci">std::string name</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00034">gscip_event_handler.h:34</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html">operations_research::GScipEventHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00090">gscip_event_handler.h:90</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_ae2d1bf271e573bcc7dfb116eba591ed6"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#ae2d1bf271e573bcc7dfb116eba591ed6">operations_research::GScipEventHandler::CatchEvent</a></div><div class="ttdeci">SCIP_RETCODE CatchEvent(SCIP_EVENTTYPE event_type)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8cc_source.html#l00116">gscip_event_handler.cc:116</a></div></div>
<div class="ttc" id="structoperations__research_1_1_g_scip_event_handler_description_html_a2e1454f6988673f814408646edaeb320"><div class="ttname"><a href="structoperations__research_1_1_g_scip_event_handler_description.html#a2e1454f6988673f814408646edaeb320">operations_research::GScipEventHandlerDescription::description</a></div><div class="ttdeci">std::string description</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00037">gscip_event_handler.h:37</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_a5c86c9f016d7d1dce57d83a04dc234ba"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a5c86c9f016d7d1dce57d83a04dc234ba">operations_research::GScipEventHandler::Register</a></div><div class="ttdeci">void Register(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8cc_source.html#l00092">gscip_event_handler.cc:92</a></div></div>
<div class="ttc" id="gscip_8h_html"><div class="ttname"><a href="gscip_8h.html">gscip.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</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="classoperations__research_1_1_g_scip_event_handler_html_af7cfe5b075a9359babf7e50af5ab0ea7"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#af7cfe5b075a9359babf7e50af5ab0ea7">operations_research::GScipEventHandler::GScipEventHandler</a></div><div class="ttdeci">GScipEventHandler(const GScipEventHandlerDescription &amp;description)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00092">gscip_event_handler.h:92</a></div></div>
<div class="ttc" id="gurobi__interface_8cc_html_a5f287b83a753915ae862fed64f8640a6"><div class="ttname"><a href="gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6">context</a></div><div class="ttdeci">GurobiMPCallbackContext * context</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00513">gurobi_interface.cc:513</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_context_html_a6a3d8f7d66730fc4792ffd23a1174b2f"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a6a3d8f7d66730fc4792ffd23a1174b2f">operations_research::GScipEventHandlerContext::GScipEventHandlerContext</a></div><div class="ttdeci">GScipEventHandlerContext(GScip *gscip, SCIP_EVENTTYPE event_type)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00046">gscip_event_handler.h:46</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_html_a1d5da6cf76ace8b0ada0cb36477c47cf"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler.html#a1d5da6cf76ace8b0ada0cb36477c47cf">operations_research::GScipEventHandler::Init</a></div><div class="ttdeci">virtual SCIP_RETCODE Init(GScip *gscip)</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00113">gscip_event_handler.h:113</a></div></div>
<div class="ttc" id="classoperations__research_1_1_g_scip_event_handler_context_html_a46f6218bbc44aafe327797363fd20cc9"><div class="ttname"><a href="classoperations__research_1_1_g_scip_event_handler_context.html#a46f6218bbc44aafe327797363fd20cc9">operations_research::GScipEventHandlerContext::event_type</a></div><div class="ttdeci">SCIP_EVENTTYPE event_type() const</div><div class="ttdef"><b>Definition:</b> <a href="gscip__event__handler_8h_source.html#l00053">gscip_event_handler.h:53</a></div></div>
2021-04-27 23:00:03 +02:00
</div><!-- fragment --></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_7ebe005d782fae78e581b12d74364053.html">gscip</a></li><li class="navelem"><a class="el" href="gscip__event__handler_8h.html">gscip_event_handler.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2021-09-20 15:57:27 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2021-04-27 23:00:03 +02:00
</ul>
</div>
</body>
</html>