Files
ortools-clone/docs/cpp/graph__export_8h_source.html
Mizux Seiha 3b81c981c2 Update doc
2022-03-04 00:19:15 +01:00

183 lines
22 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: graph_export.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>
<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.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&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('graph__export_8h_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">graph_export.h</div></div>
</div><!--header-->
<div class="contents">
<a href="graph__export_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_UTIL_GRAPH_EXPORT_H_</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_UTIL_GRAPH_EXPORT_H_</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &quot;<a class="code" href="base_2file_8h.html">ortools/base/file.h</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><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 id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;<a class="code" href="macros_8h.html">ortools/base/macros.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// ----- Export to graph file -----</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">// This class will allow the creation of a graph representation.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// It supports different formats (see GraphFormat).</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html"> 28</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1_graph_exporter.html">GraphExporter</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// Supported graph formats.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111"> 31</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111">GraphFormat</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a17799506ea003b71e0d48d86560ba840"> 32</a></span> <a class="code hl_enumvalue" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a17799506ea003b71e0d48d86560ba840">DOT_FORMAT</a>,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a02bbafc55a2078a17b27840fdf19070a"> 33</a></span> <a class="code hl_enumvalue" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a02bbafc55a2078a17b27840fdf19070a">GML_FORMAT</a>,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> };</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">virtual</span> <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#aeba2a3669464e295b74b4c3572fdab1a">~GraphExporter</a>();</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// Write the header of the graph file.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#ac3588e4392e15b8ef203f0436f45a65b"> 39</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#ac3588e4392e15b8ef203f0436f45a65b">WriteHeader</a>(<span class="keyword">const</span> std::string&amp; <a class="code hl_variable" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a>) = 0;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Write the footer of the graph file.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#a8b861de7720d855ba542f66ae2e50ce9"> 42</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#a8b861de7720d855ba542f66ae2e50ce9">WriteFooter</a>() = 0;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Write node in GML or DOT format.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#a4d172af7ba3eb9ae5b0c0e212dd06e4a"> 45</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#a4d172af7ba3eb9ae5b0c0e212dd06e4a">WriteNode</a>(<span class="keyword">const</span> std::string&amp; <a class="code hl_variable" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a>, <span class="keyword">const</span> std::string&amp; label,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">const</span> std::string&amp; shape,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> std::string&amp; color) = 0;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// Adds one link in the generated graph.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_graph_exporter.html#aaa74dfbec81925cc3c09ca670be03f8c"> 50</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#aaa74dfbec81925cc3c09ca670be03f8c">WriteLink</a>(<span class="keyword">const</span> std::string&amp; source,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">const</span> std::string&amp; destination,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">const</span> std::string&amp; label) = 0;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Creates a graph exporter that will write to file with a given format.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">static</span> <a class="code hl_class" href="classoperations__research_1_1_graph_exporter.html">GraphExporter</a>* <a class="code hl_function" href="classoperations__research_1_1_graph_exporter.html#aedf80faa1bc5343e032372bfe5cb7523">MakeFileExporter</a>(<a class="code hl_class" href="class_file.html">File</a>* <span class="keyword">const</span> <a class="code hl_namespace" href="namespacefile.html">file</a>,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_enumeration" href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111">GraphExporter::GraphFormat</a> format);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>} <span class="comment">// namespace operations_research</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_UTIL_GRAPH_EXPORT_H_</span></div>
<div class="ttc" id="abase_2file_8h_html"><div class="ttname"><a href="base_2file_8h.html">file.h</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="aclass_file_html"><div class="ttname"><a href="class_file.html">File</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00033">base/file.h:33</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html">operations_research::GraphExporter</a></div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8h_source.html#l00028">graph_export.h:28</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_a4d172af7ba3eb9ae5b0c0e212dd06e4a"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#a4d172af7ba3eb9ae5b0c0e212dd06e4a">operations_research::GraphExporter::WriteNode</a></div><div class="ttdeci">virtual void WriteNode(const std::string &amp;name, const std::string &amp;label, const std::string &amp;shape, const std::string &amp;color)=0</div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_a8b861de7720d855ba542f66ae2e50ce9"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#a8b861de7720d855ba542f66ae2e50ce9">operations_research::GraphExporter::WriteFooter</a></div><div class="ttdeci">virtual void WriteFooter()=0</div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aa8dc121542dadf05299b389c9bd16111"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111">operations_research::GraphExporter::GraphFormat</a></div><div class="ttdeci">GraphFormat</div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8h_source.html#l00031">graph_export.h:31</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aa8dc121542dadf05299b389c9bd16111a02bbafc55a2078a17b27840fdf19070a"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a02bbafc55a2078a17b27840fdf19070a">operations_research::GraphExporter::GML_FORMAT</a></div><div class="ttdeci">@ GML_FORMAT</div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8h_source.html#l00033">graph_export.h:33</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aa8dc121542dadf05299b389c9bd16111a17799506ea003b71e0d48d86560ba840"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aa8dc121542dadf05299b389c9bd16111a17799506ea003b71e0d48d86560ba840">operations_research::GraphExporter::DOT_FORMAT</a></div><div class="ttdeci">@ DOT_FORMAT</div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8h_source.html#l00032">graph_export.h:32</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aaa74dfbec81925cc3c09ca670be03f8c"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aaa74dfbec81925cc3c09ca670be03f8c">operations_research::GraphExporter::WriteLink</a></div><div class="ttdeci">virtual void WriteLink(const std::string &amp;source, const std::string &amp;destination, const std::string &amp;label)=0</div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_ac3588e4392e15b8ef203f0436f45a65b"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#ac3588e4392e15b8ef203f0436f45a65b">operations_research::GraphExporter::WriteHeader</a></div><div class="ttdeci">virtual void WriteHeader(const std::string &amp;name)=0</div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aeba2a3669464e295b74b4c3572fdab1a"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aeba2a3669464e295b74b4c3572fdab1a">operations_research::GraphExporter::~GraphExporter</a></div><div class="ttdeci">virtual ~GraphExporter()</div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8cc_source.html#l00026">graph_export.cc:26</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_graph_exporter_html_aedf80faa1bc5343e032372bfe5cb7523"><div class="ttname"><a href="classoperations__research_1_1_graph_exporter.html#aedf80faa1bc5343e032372bfe5cb7523">operations_research::GraphExporter::MakeFileExporter</a></div><div class="ttdeci">static GraphExporter * MakeFileExporter(File *const file, GraphExporter::GraphFormat format)</div><div class="ttdef"><b>Definition:</b> <a href="graph__export_8cc_source.html#l00154">graph_export.cc:154</a></div></div>
<div class="ttc" id="adefault__search_8cc_html_ac673bc430bdc3fdaa09f7becf98ef267"><div class="ttname"><a href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a></div><div class="ttdeci">const std::string name</div><div class="ttdef"><b>Definition:</b> <a href="default__search_8cc_source.html#l00813">default_search.cc:813</a></div></div>
<div class="ttc" id="amacros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div>
<div class="ttc" id="anamespacefile_html"><div class="ttname"><a href="namespacefile.html">file</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00141">base/file.cc:141</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">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><!-- 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_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="graph__export_8h.html">graph_export.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>