geos_390_docs/classgeos_1_1edgegraph_1_1E...

255 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
<title>GEOS: geos::edgegraph::EdgeGraphBuilder Class 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="doxygen.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1edgegraph.html">edgegraph</a></li><li class="navelem"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html">EdgeGraphBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::edgegraph::EdgeGraphBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="EdgeGraphBuilder_8h_source.html">EdgeGraphBuilder.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab105e87229cd72838948aebe187df858"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#ab105e87229cd72838948aebe187df858">EdgeGraphBuilder</a> ()</td></tr>
<tr class="separator:ab105e87229cd72838948aebe187df858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addd39d3059e2cfc1dd6e3d95cab34b08"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#addd39d3059e2cfc1dd6e3d95cab34b08">getGraph</a> ()</td></tr>
<tr class="separator:addd39d3059e2cfc1dd6e3d95cab34b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc75de66187ac4e4b7b6324e101f654f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#acc75de66187ac4e4b7b6324e101f654f">add</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geometry)</td></tr>
<tr class="separator:acc75de66187ac4e4b7b6324e101f654f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9da61315e584b118508518cb073fa1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#a6d9da61315e584b118508518cb073fa1">add</a> (const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> *linestring)</td></tr>
<tr class="separator:a6d9da61315e584b118508518cb073fa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9dea4924d44fce3944c90055835e9c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#ae9dea4924d44fce3944c90055835e9c9">add</a> (const <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html">geom::GeometryCollection</a> *geometries)</td></tr>
<tr class="separator:ae9dea4924d44fce3944c90055835e9c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a75ce645295e511e443b0d94a48a8c049"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#a75ce645295e511e443b0d94a48a8c049">build</a> (const <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html">geom::GeometryCollection</a> *geoms)</td></tr>
<tr class="separator:a75ce645295e511e443b0d94a48a8c049"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aee58e8bd775e37a42a33207f58ea111d"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraphBuilder.html#aee58e8bd775e37a42a33207f58ea111d">graph</a></td></tr>
<tr class="separator:aee58e8bd775e37a42a33207f58ea111d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Builds an edge graph from geometries containing edges.</p>
<dl class="section author"><dt>Author</dt><dd>mdavis </dd></dl>
<p>Definition at line <a class="el" href="EdgeGraphBuilder_8h_source.html#l00044">44</a> of file <a class="el" href="EdgeGraphBuilder_8h_source.html">EdgeGraphBuilder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab105e87229cd72838948aebe187df858"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::edgegraph::EdgeGraphBuilder::EdgeGraphBuilder </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="EdgeGraphBuilder_8h_source.html#l00055">55</a> of file <a class="el" href="EdgeGraphBuilder_8h_source.html">EdgeGraphBuilder.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acc75de66187ac4e4b7b6324e101f654f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::edgegraph::EdgeGraphBuilder::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *&#160;</td>
<td class="paramname"><em>geometry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the edges of a Geometry to the graph. May be called multiple times. Any dimension of Geometry may be added; the constituent edges are extracted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">geometry</td><td>geometry to be added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6d9da61315e584b118508518cb073fa1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::edgegraph::EdgeGraphBuilder::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1LineString.html">geom::LineString</a> *&#160;</td>
<td class="paramname"><em>linestring</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae9dea4924d44fce3944c90055835e9c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::edgegraph::EdgeGraphBuilder::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html">geom::GeometryCollection</a> *&#160;</td>
<td class="paramname"><em>geometries</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the edges in a collection of <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> to the graph. May be called multiple times. Any dimension of Geometry may be added.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">geometries</td><td>the geometries to be added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a75ce645295e511e443b0d94a48a8c049"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;<a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a>&gt; geos::edgegraph::EdgeGraphBuilder::build </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html">geom::GeometryCollection</a> *&#160;</td>
<td class="paramname"><em>geoms</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="addd39d3059e2cfc1dd6e3d95cab34b08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a>&gt; geos::edgegraph::EdgeGraphBuilder::getGraph </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aee58e8bd775e37a42a33207f58ea111d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgeos_1_1edgegraph_1_1EdgeGraph.html">EdgeGraph</a>&gt; geos::edgegraph::EdgeGraphBuilder::graph</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="EdgeGraphBuilder_8h_source.html#l00049">49</a> of file <a class="el" href="EdgeGraphBuilder_8h_source.html">EdgeGraphBuilder.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="EdgeGraphBuilder_8h_source.html">EdgeGraphBuilder.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>