geos_390_docs/classgeos_1_1geom_1_1prep_1...

208 lines
11 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::geom::prep::PreparedGeometryFactory 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_1geom.html">geom</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1geom_1_1prep.html">prep</a></li><li class="navelem"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html">PreparedGeometryFactory</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="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::geom::prep::PreparedGeometryFactory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A factory for creating <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a>s.
<a href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PreparedGeometryFactory_8h_source.html">PreparedGeometryFactory.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:ad77ef6cecdecb00b0b7569e6512a72c0"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html#ad77ef6cecdecb00b0b7569e6512a72c0">create</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geom) const </td></tr>
<tr class="separator:ad77ef6cecdecb00b0b7569e6512a72c0"><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:ae964932a0e92a24f34679c129a82b902"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html#ae964932a0e92a24f34679c129a82b902">prepare</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">geom::Geometry</a> *geom)</td></tr>
<tr class="separator:ae964932a0e92a24f34679c129a82b902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c7d2ea14548aaa8fc6e397d1a4e770"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html#ac7c7d2ea14548aaa8fc6e397d1a4e770">destroy</a> (const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> *geom)</td></tr>
<tr class="separator:ac7c7d2ea14548aaa8fc6e397d1a4e770"><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>A factory for creating <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a>s. </p>
<p>It chooses an appropriate implementation of <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html" title="An interface for classes which prepare Geometrys in order to optimize the performance of repeated cal...">PreparedGeometry</a> based on the geoemtric type of the input geometry. In the future, the factory may accept hints that indicate special optimizations which can be performed.</p>
<dl class="section author"><dt>Author</dt><dd>Martin Davis </dd></dl>
<p>Definition at line <a class="el" href="PreparedGeometryFactory_8h_source.html#l00054">54</a> of file <a class="el" href="PreparedGeometryFactory_8h_source.html">PreparedGeometryFactory.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad77ef6cecdecb00b0b7569e6512a72c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a>&gt; geos::geom::prep::PreparedGeometryFactory::create </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>geom</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> appropriate for the argument <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">geom</td><td>the geometry to prepare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the prepared geometry </dd></dl>
<p>Referenced by <a class="el" href="PreparedGeometryFactory_8h_source.html#l00064">prepare()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory_ad77ef6cecdecb00b0b7569e6512a72c0_icgraph.svg" width="464" height="55"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac7c7d2ea14548aaa8fc6e397d1a4e770"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void geos::geom::prep::PreparedGeometryFactory::destroy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> *&#160;</td>
<td class="paramname"><em>geom</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>Destroys <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> allocated with the factory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">geom</td><td>to be deallocated </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="PreparedGeometryFactory_8h_source.html#l00076">76</a> of file <a class="el" href="PreparedGeometryFactory_8h_source.html">PreparedGeometryFactory.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae964932a0e92a24f34679c129a82b902"></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_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a>&gt; geos::geom::prep::PreparedGeometryFactory::prepare </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>geom</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>Creates a new <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometry.html">PreparedGeometry</a> appropriate for the argument <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">geom</td><td>the geometry to prepare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the prepared geometry </dd></dl>
<p>Definition at line <a class="el" href="PreparedGeometryFactory_8h_source.html#l00064">64</a> of file <a class="el" href="PreparedGeometryFactory_8h_source.html">PreparedGeometryFactory.h</a>.</p>
<p>References <a class="el" href="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory.html#ad77ef6cecdecb00b0b7569e6512a72c0">create()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1geom_1_1prep_1_1PreparedGeometryFactory_ae964932a0e92a24f34679c129a82b902_cgraph.svg" width="464" height="55"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PreparedGeometryFactory_8h_source.html">PreparedGeometryFactory.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>