<!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"/> <title>GEOS: geos::geom::MultiLineString Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related 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 class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"> <ul> <li><a class="el" href="namespacegeos.html">geos</a> </li> <li><a class="el" href="namespacegeos_1_1geom.html">geom</a> </li> <li><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">geos::geom::MultiLineString</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <h1>geos::geom::MultiLineString Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="geos::geom::MultiLineString" --><!-- doxytag: inherits="geos::geom::GeometryCollection" --> <p>Basic implementation of <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a> objects. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="MultiLineString_8h_source.html">MultiLineString.h</a>></code></p> <div class="dynheader"> Inheritance diagram for geos::geom::MultiLineString:</div> <div class="dyncontent"> <div class="center"> <img src="classgeos_1_1geom_1_1MultiLineString.png" usemap="#geos::geom::MultiLineString_map" alt=""/> <map id="geos::geom::MultiLineString_map" name="geos::geom::MultiLineString_map"> <area href="classgeos_1_1geom_1_1GeometryCollection.html" alt="geos::geom::GeometryCollection" shape="rect" coords="0,56,191,80"/> <area href="classgeos_1_1geom_1_1Geometry.html" alt="geos::geom::Geometry" shape="rect" coords="0,0,191,24"/> </map> </div> <p><a href="classgeos_1_1geom_1_1MultiLineString-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5e24e57a9314095772a833bac13a9a0"></a><!-- doxytag: member="geos::geom::MultiLineString::getDimension" ref="aa5e24e57a9314095772a833bac13a9a0" args="() const " --> <a class="el" href="classgeos_1_1geom_1_1Dimension.html#af46f1c0c325eb685fcf32987748d04cf">Dimension::DimensionType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#aa5e24e57a9314095772a833bac13a9a0">getDimension</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns line dimension (1). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1681ef99f02e8d3fb6af1ebea00580e9"></a><!-- doxytag: member="geos::geom::MultiLineString::getBoundaryDimension" ref="a1681ef99f02e8d3fb6af1ebea00580e9" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#a1681ef99f02e8d3fb6af1ebea00580e9">getBoundaryDimension</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <a class="el" href="classgeos_1_1geom_1_1Dimension.html#af46f1c0c325eb685fcf32987748d04cfa5055f3028cec299275cd330122f086e2" title="Dimension value of the empty geometry (-1).">Dimension::False</a> if all LineStrings in the collection are closed, 0 otherwise. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4759ffa1782daeabf4cfb6891f703db"></a><!-- doxytag: member="geos::geom::MultiLineString::getBoundary" ref="af4759ffa1782daeabf4cfb6891f703db" args="() const " --> <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#af4759ffa1782daeabf4cfb6891f703db">getBoundary</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a (possibly empty) <a class="el" href="classgeos_1_1geom_1_1MultiPoint.html" title="Models a collection of Point objects.">MultiPoint</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e77cb1c96b0a29d1a66f62654d1f897"></a><!-- doxytag: member="geos::geom::MultiLineString::getGeometryType" ref="a1e77cb1c96b0a29d1a66f62654d1f897" args="() const " --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#a1e77cb1c96b0a29d1a66f62654d1f897">getGeometryType</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of this <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> type. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae0ce3f831c6a3ef99ef6f1010d4b211"></a><!-- doxytag: member="geos::geom::MultiLineString::getGeometryTypeId" ref="aae0ce3f831c6a3ef99ef6f1010d4b211" args="() const " --> virtual <a class="el" href="namespacegeos_1_1geom.html#a98c5b0e81001a7c3fdc7a058960356d8">GeometryTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#aae0ce3f831c6a3ef99ef6f1010d4b211">getGeometryTypeId</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return an integer representation of this <a class="el" href="classgeos_1_1geom_1_1Geometry.html" title="Basic implementation of Geometry, constructed and destructed by GeometryFactory.">Geometry</a> type. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ff7b1346596f4fa70d5187dc2a1fdbe"></a><!-- doxytag: member="geos::geom::MultiLineString::isClosed" ref="a4ff7b1346596f4fa70d5187dc2a1fdbe" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><b>isClosed</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42c3652080543223209132d8ac0d0dfe"></a><!-- doxytag: member="geos::geom::MultiLineString::equalsExact" ref="a42c3652080543223209132d8ac0d0dfe" args="(const Geometry *other, double tolerance=0) const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#a42c3652080543223209132d8ac0d0dfe">equalsExact</a> (const <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> *other, double tolerance=0) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two Geometrys are exactly equal, up to a specified tolerance. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#a772aab048197c3b89176fa2df813bdfc">clone</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">MultiLineString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#ae4299f2b10ae3d710039506906f86dac">reverse</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html#affa54bec1519e8f87c0a50ecc9a3caf2">MultiLineString</a> (std::vector< <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * > *newLines, const <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a> *newFactory)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <code><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a></code>. <a href="#affa54bec1519e8f87c0a50ecc9a3caf2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4190adfb5d812e1d28e6ce9e368720c3"></a><!-- doxytag: member="geos::geom::MultiLineString::MultiLineString" ref="a4190adfb5d812e1d28e6ce9e368720c3" args="(const MultiLineString &mp)" --> </td><td class="memItemRight" valign="bottom"><b>MultiLineString</b> (const <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">MultiLineString</a> &mp)</td></tr> <tr><td colspan="2"><h2><a name="friends"></a> Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a639aef3f5d0d27a72053343b0e09b5f3"></a><!-- doxytag: member="geos::geom::MultiLineString::GeometryFactory" ref="a639aef3f5d0d27a72053343b0e09b5f3" args="" --> class </td><td class="memItemRight" valign="bottom"><b>GeometryFactory</b></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Basic implementation of <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a> objects. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="affa54bec1519e8f87c0a50ecc9a3caf2"></a><!-- doxytag: member="geos::geom::MultiLineString::MultiLineString" ref="affa54bec1519e8f87c0a50ecc9a3caf2" args="(std::vector< Geometry * > *newLines, const GeometryFactory *newFactory)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">geos::geom::MultiLineString::MultiLineString </td> <td>(</td> <td class="paramtype">std::vector< <a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a> * > * </td> <td class="paramname"> <em>newLines</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html">GeometryFactory</a> * </td> <td class="paramname"> <em>newFactory</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs a <code><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a></code>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>newLines</em> </td><td>The <code>LineStrings</code>s for this <code><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a></code>, or <code>null</code> or an empty array to create the empty geometry. Elements may be empty <code><a class="el" href="classgeos_1_1geom_1_1LineString.html" title="Basic implementation of LineString.">LineString</a></code>s, but not <code>null</code>s.</td></tr> </table> </dd> </dl> <p>Constructed object will take ownership of the vector and its elements.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>newFactory</em> </td><td>The <a class="el" href="classgeos_1_1geom_1_1GeometryFactory.html" title="Supplies a set of utility methods for building Geometry objects from CoordinateSequence or other Geom...">GeometryFactory</a> used to create this geometry. Caller must keep the factory alive for the life-time of the constructed <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a>. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a772aab048197c3b89176fa2df813bdfc"></a><!-- doxytag: member="geos::geom::MultiLineString::clone" ref="a772aab048197c3b89176fa2df813bdfc" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgeos_1_1geom_1_1Geometry.html">Geometry</a>* geos::geom::MultiLineString::clone </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates and returns a full copy of this <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html" title="Represents a collection of heterogeneous Geometry objects.">GeometryCollection</a> object. (including all coordinates contained by it).</p> <dl class="return"><dt><b>Returns:</b></dt><dd>a clone of this instance </dd></dl> <p>Reimplemented from <a class="el" href="classgeos_1_1geom_1_1GeometryCollection.html#a3b30808a1d17d793bdfb8db9cbacc755">geos::geom::GeometryCollection</a>.</p> </div> </div> <a class="anchor" id="ae4299f2b10ae3d710039506906f86dac"></a><!-- doxytag: member="geos::geom::MultiLineString::reverse" ref="ae4299f2b10ae3d710039506906f86dac" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgeos_1_1geom_1_1MultiLineString.html">MultiLineString</a>* geos::geom::MultiLineString::reverse </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Creates a <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a> in the reverse order to this object. Both the order of the component LineStrings and the order of their coordinate sequences are reversed.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classgeos_1_1geom_1_1MultiLineString.html" title="Basic implementation of MultiLineString objects.">MultiLineString</a> in the reverse order </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="MultiLineString_8h_source.html">MultiLineString.h</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Thu Jul 22 2010 for GEOS by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>