<!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::planargraph::Edge 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_1planargraph.html">planargraph</a> </li>
<li><a class="el" href="classgeos_1_1planargraph_1_1Edge.html">geos::planargraph::Edge</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="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>geos::planargraph::Edge Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::planargraph::Edge" --><!-- doxytag: inherits="geos::planargraph::GraphComponent" -->
<p>Represents an undirected edge of a <a class="el" href="classgeos_1_1planargraph_1_1PlanarGraph.html" title="Represents a directed graph which is embeddable in a planar surface.">PlanarGraph</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="planargraph_2Edge_8h_source.html">Edge.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::planargraph::Edge:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1planargraph_1_1Edge.png" usemap="#geos::planargraph::Edge_map" alt=""/>
<map id="geos::planargraph::Edge_map" name="geos::planargraph::Edge_map">
<area href="classgeos_1_1planargraph_1_1GraphComponent.html" alt="geos::planargraph::GraphComponent" shape="rect" coords="0,0,255,24"/>
<area href="classgeos_1_1operation_1_1linemerge_1_1LineMergeEdge.html" alt="geos::operation::linemerge::LineMergeEdge" shape="rect" coords="0,112,255,136"/>
</map>
</div>
<p><a href="classgeos_1_1planargraph_1_1Edge-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="a4750ca80bebe5b3cf1b19089c8d88214"></a><!-- doxytag: member="geos::planargraph::Edge::ConstSet" ref="a4750ca80bebe5b3cf1b19089c8d88214" args="" -->
typedef std::set< const <a class="el" href="classgeos_1_1planargraph_1_1Edge.html">Edge</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a4750ca80bebe5b3cf1b19089c8d88214">ConstSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set of const Edges pointers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36392eaf78cad7831714df3cba496fc8"></a><!-- doxytag: member="geos::planargraph::Edge::NonConstSet" ref="a36392eaf78cad7831714df3cba496fc8" args="" -->
typedef std::set< <a class="el" href="classgeos_1_1planargraph_1_1Edge.html">Edge</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a36392eaf78cad7831714df3cba496fc8">NonConstSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set of non-const Edges pointers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aceb74932b81d8e025ae78857e1dbe86f"></a><!-- doxytag: member="geos::planargraph::Edge::NonConstVect" ref="aceb74932b81d8e025ae78857e1dbe86f" args="" -->
typedef std::vector< <a class="el" href="classgeos_1_1planargraph_1_1Edge.html">Edge</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#aceb74932b81d8e025ae78857e1dbe86f">NonConstVect</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vector of non-const Edges pointers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bdb3e096dd35b2ec8782d1005050983"></a><!-- doxytag: member="geos::planargraph::Edge::ConstVect" ref="a1bdb3e096dd35b2ec8782d1005050983" args="" -->
typedef std::vector< const <a class="el" href="classgeos_1_1planargraph_1_1Edge.html">Edge</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a1bdb3e096dd35b2ec8782d1005050983">ConstVect</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vector of const Edges pointers. <br/></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_1planargraph_1_1Edge.html#a3af12e9de07e5cbe721b6cb6f20aaaf6">Edge</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> whose DirectedEdges are not yet set. <a href="#a3af12e9de07e5cbe721b6cb6f20aaaf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a4532f3aaca8325463252fbe8e1026cca">Edge</a> (<a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> *de0, <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> *de1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> initialized with the given DirectedEdges. <a href="#a4532f3aaca8325463252fbe8e1026cca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#ad6886a455d448cd5cc3b181f50ae1b85">setDirectedEdges</a> (<a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> *de0, <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> *de1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes this Edge's two DirectedEdges. <a href="#ad6886a455d448cd5cc3b181f50ae1b85"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a8380830e81f5bbcbc504fa214e5e9838">getDirEdge</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the DirectedEdges associated with this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>. <a href="#a8380830e81f5bbcbc504fa214e5e9838"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62906581b8cbcde7a4c18ee26b68e12a"></a><!-- doxytag: member="geos::planargraph::Edge::getDirEdge" ref="a62906581b8cbcde7a4c18ee26b68e12a" args="(Node *fromNode)" -->
<a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a62906581b8cbcde7a4c18ee26b68e12a">getDirEdge</a> (<a class="el" href="classgeos_1_1planargraph_1_1Node.html">Node</a> *fromNode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a> that starts from the given node, or null if the node is not one of the two nodes associated with this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7c50a6eaad7a311279ad6ca1e19ac42"></a><!-- doxytag: member="geos::planargraph::Edge::getOppositeNode" ref="aa7c50a6eaad7a311279ad6ca1e19ac42" args="(Node *node)" -->
<a class="el" href="classgeos_1_1planargraph_1_1Node.html">Node</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#aa7c50a6eaad7a311279ad6ca1e19ac42">getOppositeNode</a> (<a class="el" href="classgeos_1_1planargraph_1_1Node.html">Node</a> *node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If <code>node</code> is one of the two nodes associated with this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>, returns the other node; otherwise returns null. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaf53e9bdd2ef9f55631bef0cf0c0408"></a><!-- doxytag: member="geos::planargraph::Edge::dirEdge" ref="acaf53e9bdd2ef9f55631bef0cf0c0408" args="" -->
std::vector< <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#acaf53e9bdd2ef9f55631bef0cf0c0408">dirEdge</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The two DirectedEdges associated with this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>. <br/></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="a0e83b3c048d2aae2ff19a4629820b596"></a><!-- doxytag: member="geos::planargraph::Edge::operator<<" ref="a0e83b3c048d2aae2ff19a4629820b596" args="(std::ostream &os, const Node &)" -->
std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1Edge.html#a0e83b3c048d2aae2ff19a4629820b596">operator<<</a> (std::ostream &os, const <a class="el" href="classgeos_1_1planargraph_1_1Node.html">Node</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a <a class="el" href="classgeos_1_1planargraph_1_1Node.html" title="A node in a PlanarGraph is a location where 0 or more Edge meet.">Node</a>. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents an undirected edge of a <a class="el" href="classgeos_1_1planargraph_1_1PlanarGraph.html" title="Represents a directed graph which is embeddable in a planar surface.">PlanarGraph</a>. </p>
<p>An undirected edge in fact simply acts as a central point of reference for two opposite <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a>.</p>
<p>Usually a client using a <a class="el" href="classgeos_1_1planargraph_1_1PlanarGraph.html" title="Represents a directed graph which is embeddable in a planar surface.">PlanarGraph</a> will subclass <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> to add its own application-specific data and methods. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3af12e9de07e5cbe721b6cb6f20aaaf6"></a><!-- doxytag: member="geos::planargraph::Edge::Edge" ref="a3af12e9de07e5cbe721b6cb6f20aaaf6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::planargraph::Edge::Edge </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs an <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> whose DirectedEdges are not yet set. </p>
<p>Be sure to call setDirectedEdges(DirectedEdge, DirectedEdge) Constructs a <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> whose DirectedEdges are not yet set. Be sure to call <a class="el" href="">setDirectedEdges(DirectedEdge, DirectedEdge)</a> </p>
</div>
</div>
<a class="anchor" id="a4532f3aaca8325463252fbe8e1026cca"></a><!-- doxytag: member="geos::planargraph::Edge::Edge" ref="a4532f3aaca8325463252fbe8e1026cca" args="(DirectedEdge *de0, DirectedEdge *de1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::planargraph::Edge::Edge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td>
<td class="paramname"> <em>de0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td>
<td class="paramname"> <em>de1</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs an <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> initialized with the given DirectedEdges. </p>
<p>For each <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a>: sets the <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>, sets the symmetric <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a>, and adds this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> to its from-Node. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8380830e81f5bbcbc504fa214e5e9838"></a><!-- doxytag: member="geos::planargraph::Edge::getDirEdge" ref="a8380830e81f5bbcbc504fa214e5e9838" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a>* geos::planargraph::Edge::getDirEdge </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns one of the DirectedEdges associated with this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</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>i</em> </td><td>0 or 1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad6886a455d448cd5cc3b181f50ae1b85"></a><!-- doxytag: member="geos::planargraph::Edge::setDirectedEdges" ref="ad6886a455d448cd5cc3b181f50ae1b85" args="(DirectedEdge *de0, DirectedEdge *de1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::planargraph::Edge::setDirectedEdges </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td>
<td class="paramname"> <em>de0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html">DirectedEdge</a> * </td>
<td class="paramname"> <em>de1</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes this Edge's two DirectedEdges. </p>
<p>For each <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a>: sets the <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a>, sets the symmetric <a class="el" href="classgeos_1_1planargraph_1_1DirectedEdge.html" title="Represents a directed edge in a PlanarGraph.">DirectedEdge</a>, and adds this <a class="el" href="classgeos_1_1planargraph_1_1Edge.html" title="Represents an undirected edge of a PlanarGraph.">Edge</a> to its from-Node. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="planargraph_2Edge_8h_source.html">planargraph/Edge.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>
