geos_390_docs/classgeos_1_1geom_1_1Coordi...

<!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::CoordinateSequenceFactory 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="classgeos_1_1geom_1_1CoordinateSequenceFactory.html">CoordinateSequenceFactory</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classgeos_1_1geom_1_1CoordinateSequenceFactory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">geos::geom::CoordinateSequenceFactory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>A factory to create concrete instances of <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>s.
 <a href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="CoordinateSequenceFactory_8h_source.html">CoordinateSequenceFactory.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for geos::geom::CoordinateSequenceFactory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1geom_1_1CoordinateSequenceFactory__inherit__graph.svg" width="523" height="123"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a12a0b8249c2cf41ac8b7316051b7fb00"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#a12a0b8249c2cf41ac8b7316051b7fb00">create</a> () const =0</td></tr>
<tr class="memdesc:a12a0b8249c2cf41ac8b7316051b7fb00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an empty <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a>, the dimensions will be autodetected when it is populated.  <a href="#a12a0b8249c2cf41ac8b7316051b7fb00">More...</a><br /></td></tr>
<tr class="separator:a12a0b8249c2cf41ac8b7316051b7fb00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54dbbc526aa53d716a7bdc443e40efaa"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#a54dbbc526aa53d716a7bdc443e40efaa">create</a> (std::vector&lt; <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> &gt; *coordinates, std::size_t dimension=0) const =0</td></tr>
<tr class="memdesc:a54dbbc526aa53d716a7bdc443e40efaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> based on the given array.  <a href="#a54dbbc526aa53d716a7bdc443e40efaa">More...</a><br /></td></tr>
<tr class="separator:a54dbbc526aa53d716a7bdc443e40efaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c94ff71a513acf9d6c92063f7682a64"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#a8c94ff71a513acf9d6c92063f7682a64">create</a> (std::vector&lt; <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> &gt; &amp;&amp;coordinates, std::size_t dimension=0) const =0</td></tr>
<tr class="memdesc:a8c94ff71a513acf9d6c92063f7682a64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> based on the given array.  <a href="#a8c94ff71a513acf9d6c92063f7682a64">More...</a><br /></td></tr>
<tr class="separator:a8c94ff71a513acf9d6c92063f7682a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f8f0a94a5159eca2a2869978abeaeee"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#a3f8f0a94a5159eca2a2869978abeaeee">create</a> (std::size_t size, std::size_t dimension=0) const =0</td></tr>
<tr class="memdesc:a3f8f0a94a5159eca2a2869978abeaeee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> of the specified size and dimension.  <a href="#a3f8f0a94a5159eca2a2869978abeaeee">More...</a><br /></td></tr>
<tr class="separator:a3f8f0a94a5159eca2a2869978abeaeee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2803dc9191450c8f36bcb82b2f58d13"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#ad2803dc9191450c8f36bcb82b2f58d13">create</a> (const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &amp;coordSeq) const =0</td></tr>
<tr class="memdesc:ad2803dc9191450c8f36bcb82b2f58d13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> which is a copy of the given one.  <a href="#ad2803dc9191450c8f36bcb82b2f58d13">More...</a><br /></td></tr>
<tr class="separator:ad2803dc9191450c8f36bcb82b2f58d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6060ceb0158fb6bd7257f83836ea393"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1CoordinateSequenceFactory.html#ae6060ceb0158fb6bd7257f83836ea393">~CoordinateSequenceFactory</a> ()=default</td></tr>
<tr class="separator:ae6060ceb0158fb6bd7257f83836ea393"><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 to create concrete instances of <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>s. </p>
<p>Used to configure <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a>s to provide specific kinds of CoordinateSequences. </p>

<p>Definition at line <a class="el" href="CoordinateSequenceFactory_8h_source.html#l00048">48</a> of file <a class="el" href="CoordinateSequenceFactory_8h_source.html">CoordinateSequenceFactory.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae6060ceb0158fb6bd7257f83836ea393"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual geos::geom::CoordinateSequenceFactory::~CoordinateSequenceFactory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a12a0b8249c2cf41ac8b7316051b7fb00"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>&gt; geos::geom::CoordinateSequenceFactory::create </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns an empty <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a>, the dimensions will be autodetected when it is populated. </p>

<p>Implemented in <a class="el" href="classgeos_1_1geom_1_1CoordinateArraySequenceFactory.html#a2e41ad97ba46dbc98881539e9f72f998">geos::geom::CoordinateArraySequenceFactory</a>, and <a class="el" href="classgeos_1_1geom_1_1DefaultCoordinateSequenceFactory.html#ae877404344d32020cda5093a83d186ca">geos::geom::DefaultCoordinateSequenceFactory</a>.</p>

</div>
</div>
<a class="anchor" id="a54dbbc526aa53d716a7bdc443e40efaa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>&gt; geos::geom::CoordinateSequenceFactory::create </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> &gt; *&#160;</td>
          <td class="paramname"><em>coordinates</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>dimension</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> based on the given array. </p>
<p>Whether the array is copied or simply referenced is implementation-dependent. For this reason caller does give up ownership of it. Implementations that will not copy it will need take care of deleting it.</p>
<p>This method must handle null arguments by creating an empty sequence.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">coordinates</td><td>the coordinates </td></tr>
    <tr><td class="paramname">dimension</td><td>0, 2 or 3 with 0 indicating unknown at this time. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgeos_1_1geom_1_1CoordinateArraySequenceFactory.html#ac4cdcd8209961d4a7176b72ca80fa83a">geos::geom::CoordinateArraySequenceFactory</a>, and <a class="el" href="classgeos_1_1geom_1_1DefaultCoordinateSequenceFactory.html#a381894ef95e77e1b1a521fa688a66467">geos::geom::DefaultCoordinateSequenceFactory</a>.</p>

</div>
</div>
<a class="anchor" id="a8c94ff71a513acf9d6c92063f7682a64"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>&gt; geos::geom::CoordinateSequenceFactory::create </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">Coordinate</a> &gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>coordinates</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>dimension</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> based on the given array. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">coordinates</td><td>the coordinates </td></tr>
    <tr><td class="paramname">dimension</td><td>0, 2 or 3 with 0 indicating unknown at this time. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgeos_1_1geom_1_1CoordinateArraySequenceFactory.html#afd6b3a18250fdd19034dfb13fc8aa488">geos::geom::CoordinateArraySequenceFactory</a>, and <a class="el" href="classgeos_1_1geom_1_1DefaultCoordinateSequenceFactory.html#a4dc9319793e3ed9f4e3824a9b001909e">geos::geom::DefaultCoordinateSequenceFactory</a>.</p>

</div>
</div>
<a class="anchor" id="a3f8f0a94a5159eca2a2869978abeaeee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>&gt; geos::geom::CoordinateSequenceFactory::create </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>dimension</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> of the specified size and dimension. </p>
<p>For this to be useful, the <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> implementation must be mutable.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>the number of coordinates in the sequence </td></tr>
    <tr><td class="paramname">dimension</td><td>the dimension of the coordinates in the sequence (0=unknown, 2, or 3 - ignored if not user specifiable) </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgeos_1_1geom_1_1CoordinateArraySequenceFactory.html#a48729892ad9c537810d12213159661b7">geos::geom::CoordinateArraySequenceFactory</a>, and <a class="el" href="classgeos_1_1geom_1_1DefaultCoordinateSequenceFactory.html#a8d3278ff0a0d276270d002845c1c803d">geos::geom::DefaultCoordinateSequenceFactory</a>.</p>

</div>
</div>
<a class="anchor" id="ad2803dc9191450c8f36bcb82b2f58d13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a>&gt; geos::geom::CoordinateSequenceFactory::create </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">CoordinateSequence</a> &amp;&#160;</td>
          <td class="paramname"><em>coordSeq</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html" title="The internal representation of a list of coordinates inside a Geometry. ">CoordinateSequence</a> which is a copy of the given one. </p>
<p>This method must handle null arguments by creating an empty sequence.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">coordSeq</td><td>the coordinate sequence to copy </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgeos_1_1geom_1_1CoordinateArraySequenceFactory.html#ab1549f62cfef7288faab4191a8debaba">geos::geom::CoordinateArraySequenceFactory</a>, and <a class="el" href="classgeos_1_1geom_1_1DefaultCoordinateSequenceFactory.html#a08cb9da8ed2f6f8aabc819907230a4d4">geos::geom::DefaultCoordinateSequenceFactory</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CoordinateSequenceFactory_8h_source.html">CoordinateSequenceFactory.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>