<!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::noding::SegmentString 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_1noding.html">noding</a> </li>
<li><a class="el" href="classgeos_1_1noding_1_1SegmentString.html">geos::noding::SegmentString</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>geos::noding::SegmentString Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::noding::SegmentString" -->
<p>An interface for classes which represent a sequence of contiguous line segments.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="SegmentString_8h_source.html">SegmentString.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::noding::SegmentString:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1noding_1_1SegmentString.png" usemap="#geos::noding::SegmentString_map" alt=""/>
<map id="geos::noding::SegmentString_map" name="geos::noding::SegmentString_map">
<area href="classgeos_1_1noding_1_1BasicSegmentString.html" alt="geos::noding::BasicSegmentString" shape="rect" coords="0,56,217,80"/>
<area href="classgeos_1_1noding_1_1NodableSegmentString.html" alt="geos::noding::NodableSegmentString" shape="rect" coords="227,56,444,80"/>
<area href="classgeos_1_1noding_1_1NodedSegmentString.html" alt="geos::noding::NodedSegmentString" shape="rect" coords="227,112,444,136"/>
</map>
</div>
<p><a href="classgeos_1_1noding_1_1SegmentString-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d906d224117f3d08ecf66664e1b81a"></a><!-- doxytag: member="geos::noding::SegmentString::ConstVect" ref="aa1d906d224117f3d08ecf66664e1b81a" args="" -->
typedef std::vector< const <br class="typebreak"/>
<a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a> * > </td><td class="memItemRight" valign="bottom"><b>ConstVect</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08852621fdeeb7777cd7bd8d25755bf8"></a><!-- doxytag: member="geos::noding::SegmentString::NonConstVect" ref="a08852621fdeeb7777cd7bd8d25755bf8" args="" -->
typedef std::vector<br class="typebreak"/>
< <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a> * > </td><td class="memItemRight" valign="bottom"><b>NonConstVect</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public 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_1noding_1_1SegmentString.html#a9bbddb9c8ba5a7b33c0a6b971536c7c4">SegmentString</a> (const void *newContext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classgeos_1_1noding_1_1SegmentString.html" title="An interface for classes which represent a sequence of contiguous line segments.">SegmentString</a>. <a href="#a9bbddb9c8ba5a7b33c0a6b971536c7c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentString.html#a834c2197c06284666ce5bf7afd5e3160">getData</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentString.html#ae904e3ae8ad4cbf87f6d72d4a74b0371">setData</a> (const void *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3b6b755c40f150c6d01cd2134c07c05"></a><!-- doxytag: member="geos::noding::SegmentString::size" ref="ab3b6b755c40f150c6d01cd2134c07c05" args="() const =0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><b>size</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60cc37174a2292b0c7de9d2861775336"></a><!-- doxytag: member="geos::noding::SegmentString::getCoordinate" ref="a60cc37174a2292b0c7de9d2861775336" args="(unsigned int i) const =0" -->
virtual const <a class="el" href="classgeos_1_1geom_1_1Coordinate.html">geom::Coordinate</a> & </td><td class="memItemRight" valign="bottom"><b>getCoordinate</b> (unsigned int i) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1SegmentString.html#aca3ec349545a36bea18be67b2763a862">getCoordinates</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the CoordinateSequence associated with this <a class="el" href="classgeos_1_1noding_1_1SegmentString.html" title="An interface for classes which represent a sequence of contiguous line segments.">SegmentString</a>. <a href="#aca3ec349545a36bea18be67b2763a862"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabf4d633db90713e82e30da182594733"></a><!-- doxytag: member="geos::noding::SegmentString::isClosed" ref="aabf4d633db90713e82e30da182594733" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>isClosed</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08126c5c3c3e939460fae55dd1b214b9"></a><!-- doxytag: member="geos::noding::SegmentString::print" ref="a08126c5c3c3e939460fae55dd1b214b9" args="(std::ostream &os) const " -->
virtual std::ostream & </td><td class="memItemRight" valign="bottom"><b>print</b> (std::ostream &os) const </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="aa6247ca4cb358f1ef12e39929b449d67"></a><!-- doxytag: member="geos::noding::SegmentString::operator<<" ref="aa6247ca4cb358f1ef12e39929b449d67" args="(std::ostream &os, const SegmentString &ss)" -->
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &os, const <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a> &ss)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An interface for classes which represent a sequence of contiguous line segments. </p>
<p>SegmentStrings can carry a context object, which is useful for preserving topological or parentage information. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9bbddb9c8ba5a7b33c0a6b971536c7c4"></a><!-- doxytag: member="geos::noding::SegmentString::SegmentString" ref="a9bbddb9c8ba5a7b33c0a6b971536c7c4" args="(const void *newContext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::noding::SegmentString::SegmentString </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>newContext</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classgeos_1_1noding_1_1SegmentString.html" title="An interface for classes which represent a sequence of contiguous line segments.">SegmentString</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newContext</em> </td><td>the context associated to this <a class="el" href="classgeos_1_1noding_1_1SegmentString.html" title="An interface for classes which represent a sequence of contiguous line segments.">SegmentString</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aca3ec349545a36bea18be67b2763a862"></a><!-- doxytag: member="geos::noding::SegmentString::getCoordinates" ref="aca3ec349545a36bea18be67b2763a862" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgeos_1_1geom_1_1CoordinateSequence.html">geom::CoordinateSequence</a>* geos::noding::SegmentString::getCoordinates </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the CoordinateSequence associated with this <a class="el" href="classgeos_1_1noding_1_1SegmentString.html" title="An interface for classes which represent a sequence of contiguous line segments.">SegmentString</a>. </p>
<p>Note that the CoordinateSequence is not owned by this SegmentString! </p>
<p>Implemented in <a class="el" href="classgeos_1_1noding_1_1BasicSegmentString.html#a848bdd2673e17250a9afa473650d1f3b">geos::noding::BasicSegmentString</a>, and <a class="el" href="classgeos_1_1noding_1_1NodedSegmentString.html#a7adec298a85c346af77b77aec279a89f">geos::noding::NodedSegmentString</a>.</p>
</div>
</div>
<a class="anchor" id="a834c2197c06284666ce5bf7afd5e3160"></a><!-- doxytag: member="geos::noding::SegmentString::getData" ref="a834c2197c06284666ce5bf7afd5e3160" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* geos::noding::SegmentString::getData </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the user-defined data for this segment string.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the user-defined data </dd></dl>
</div>
</div>
<a class="anchor" id="ae904e3ae8ad4cbf87f6d72d4a74b0371"></a><!-- doxytag: member="geos::noding::SegmentString::setData" ref="ae904e3ae8ad4cbf87f6d72d4a74b0371" args="(const void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::noding::SegmentString::setData </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the user-defined data for this segment string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>an Object containing user-defined data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SegmentString_8h_source.html">SegmentString.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>
