<!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::geomgraph::DirectedEdge 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_1geomgraph.html">geomgraph</a> </li>
<li><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">geos::geomgraph::DirectedEdge</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>geos::geomgraph::DirectedEdge Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::geomgraph::DirectedEdge" --><!-- doxytag: inherits="geos::geomgraph::EdgeEnd" -->
<p>A directed <a class="el" href="classgeos_1_1geomgraph_1_1EdgeEnd.html" title="Models the end of an edge incident on a node.">EdgeEnd</a>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="geomgraph_2DirectedEdge_8h_source.html">DirectedEdge.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::geomgraph::DirectedEdge:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1geomgraph_1_1DirectedEdge.png" usemap="#geos::geomgraph::DirectedEdge_map" alt=""/>
<map id="geos::geomgraph::DirectedEdge_map" name="geos::geomgraph::DirectedEdge_map">
<area href="classgeos_1_1geomgraph_1_1EdgeEnd.html" alt="geos::geomgraph::EdgeEnd" shape="rect" coords="0,0,191,24"/>
</map>
</div>
<p><a href="classgeos_1_1geomgraph_1_1DirectedEdge-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="a27ab737b0ee27462fb6badbd3093a827"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::DirectedEdge" ref="a27ab737b0ee27462fb6badbd3093a827" args="(Edge *newEdge, bool newIsForward)" -->
</td><td class="memItemRight" valign="bottom"><b>DirectedEdge</b> (Edge *newEdge, bool newIsForward)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42931feba2b6793916d480f236134d67"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setInResult" ref="a42931feba2b6793916d480f236134d67" args="(bool newIsInResult)" -->
void </td><td class="memItemRight" valign="bottom"><b>setInResult</b> (bool newIsInResult)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5530c2aab21213c841df8cb7bce0487e"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isInResult" ref="a5530c2aab21213c841df8cb7bce0487e" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>isInResult</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa68eeadfebc55e1eb5f00bc1ae1808d5"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isVisited" ref="aa68eeadfebc55e1eb5f00bc1ae1808d5" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>isVisited</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67be7e084fa9d132fd2b8d0f1d443a09"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setVisited" ref="a67be7e084fa9d132fd2b8d0f1d443a09" args="(bool newIsVisited)" -->
void </td><td class="memItemRight" valign="bottom"><b>setVisited</b> (bool newIsVisited)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee4107ea005ffb1f1826f85ece9485f1"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setEdgeRing" ref="aee4107ea005ffb1f1826f85ece9485f1" args="(EdgeRing *newEdgeRing)" -->
void </td><td class="memItemRight" valign="bottom"><b>setEdgeRing</b> (EdgeRing *newEdgeRing)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac48b41393614ac23cb4e93e14111cdc9"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getEdgeRing" ref="ac48b41393614ac23cb4e93e14111cdc9" args="()" -->
EdgeRing * </td><td class="memItemRight" valign="bottom"><b>getEdgeRing</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab83e00d73a2cab9dfb330de7e3ebe2de"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setMinEdgeRing" ref="ab83e00d73a2cab9dfb330de7e3ebe2de" args="(EdgeRing *newMinEdgeRing)" -->
void </td><td class="memItemRight" valign="bottom"><b>setMinEdgeRing</b> (EdgeRing *newMinEdgeRing)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea0a31471273e9c68cc3792d47c92313"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getMinEdgeRing" ref="aea0a31471273e9c68cc3792d47c92313" args="()" -->
EdgeRing * </td><td class="memItemRight" valign="bottom"><b>getMinEdgeRing</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a70f360b23e3e9cfbd5baab2f5af77f"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getDepth" ref="a7a70f360b23e3e9cfbd5baab2f5af77f" args="(int position)" -->
int </td><td class="memItemRight" valign="bottom"><b>getDepth</b> (int position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef766ed93b3879073e93d46734988f9c"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setDepth" ref="aef766ed93b3879073e93d46734988f9c" args="(int position, int newDepth)" -->
void </td><td class="memItemRight" valign="bottom"><b>setDepth</b> (int position, int newDepth)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a182da9a0b66c64b555de8bd4a44a580b"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getDepthDelta" ref="a182da9a0b66c64b555de8bd4a44a580b" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>getDepthDelta</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html#a8fb7210349aade603246371d2e4bb9f9">setVisitedEdge</a> (bool newIsVisited)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Marks both DirectedEdges attached to a given Edge. <a href="#a8fb7210349aade603246371d2e4bb9f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html#ac11c89ca0bd48de3d5fb257b69cb615e">getSym</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Each Edge gives rise to a pair of symmetric DirectedEdges, in opposite directions. <a href="#ac11c89ca0bd48de3d5fb257b69cb615e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4d04e35f4ca2ad894005ebba3631436"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isForward" ref="af4d04e35f4ca2ad894005ebba3631436" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>isForward</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a292236d792f681a83f25c25582de365f"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setSym" ref="a292236d792f681a83f25c25582de365f" args="(DirectedEdge *de)" -->
void </td><td class="memItemRight" valign="bottom"><b>setSym</b> (<a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> *de)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a582246fedabcf731dc0ced612d35b63a"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getNext" ref="a582246fedabcf731dc0ced612d35b63a" args="()" -->
<a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> * </td><td class="memItemRight" valign="bottom"><b>getNext</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafc887f517e7e46708a1ebd285ac40c6"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setNext" ref="aafc887f517e7e46708a1ebd285ac40c6" args="(DirectedEdge *newNext)" -->
void </td><td class="memItemRight" valign="bottom"><b>setNext</b> (<a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> *newNext)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a078d4bdb154c0162c5566d312ef258b2"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getNextMin" ref="a078d4bdb154c0162c5566d312ef258b2" args="()" -->
<a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> * </td><td class="memItemRight" valign="bottom"><b>getNextMin</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02ed97d278961d8a1a52860917bae8cd"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setNextMin" ref="a02ed97d278961d8a1a52860917bae8cd" args="(DirectedEdge *newNextMin)" -->
void </td><td class="memItemRight" valign="bottom"><b>setNextMin</b> (<a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a> *newNextMin)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html#a905b2884ca35084f4afafa4864edbad9">isLineEdge</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells wheter this edge is a Line. <a href="#a905b2884ca35084f4afafa4864edbad9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html#ae417600736c2294987394b7899f9630b">isInteriorAreaEdge</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells wheter this edge is an Area. <a href="#ae417600736c2294987394b7899f9630b"></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_1geomgraph_1_1DirectedEdge.html#a80dddf917030937d6c023cf532c08e19">setEdgeDepths</a> (int position, int newDepth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both edge depths. <a href="#a80dddf917030937d6c023cf532c08e19"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24d61df5bcc13ecee58e13649b79fff7"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::print" ref="a24d61df5bcc13ecee58e13649b79fff7" args="()" -->
std::string </td><td class="memItemRight" valign="bottom"><b>print</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab979dea011a6980c3d1fb20c01e9c480"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::printEdge" ref="ab979dea011a6980c3d1fb20c01e9c480" args="()" -->
std::string </td><td class="memItemRight" valign="bottom"><b>printEdge</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a321c6416543c8e62727e3a7561c4c58e"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::depthFactor" ref="a321c6416543c8e62727e3a7561c4c58e" args="(int currLocation, int nextLocation)" -->
static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html#a321c6416543c8e62727e3a7561c4c58e">depthFactor</a> (int currLocation, int nextLocation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the factor for the change in depth when moving from one location to another. E.g. if crossing from the INTERIOR to the EXTERIOR the depth decreases, so the factor is -1. <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="aff61ce1c3be1f8528ca84efe64bce71b"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isForwardVar" ref="aff61ce1c3be1f8528ca84efe64bce71b" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>isForwardVar</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A directed <a class="el" href="classgeos_1_1geomgraph_1_1EdgeEnd.html" title="Models the end of an edge incident on a node.">EdgeEnd</a>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac11c89ca0bd48de3d5fb257b69cb615e"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::getSym" ref="ac11c89ca0bd48de3d5fb257b69cb615e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html">DirectedEdge</a>* geos::geomgraph::DirectedEdge::getSym </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Each Edge gives rise to a pair of symmetric DirectedEdges, in opposite directions. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgeos_1_1geomgraph_1_1DirectedEdge.html" title="A directed EdgeEnd.">DirectedEdge</a> for the same Edge but in the opposite direction </dd></dl>
</div>
</div>
<a class="anchor" id="ae417600736c2294987394b7899f9630b"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isInteriorAreaEdge" ref="ae417600736c2294987394b7899f9630b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::geomgraph::DirectedEdge::isInteriorAreaEdge </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells wheter this edge is an Area. </p>
<p>This is an interior Area edge if</p>
<ul>
<li>its label is an Area label for both Geometries</li>
<li>and for each Geometry both sides are in the interior.</li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is an interior Area edge </dd></dl>
</div>
</div>
<a class="anchor" id="a905b2884ca35084f4afafa4864edbad9"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::isLineEdge" ref="a905b2884ca35084f4afafa4864edbad9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::geomgraph::DirectedEdge::isLineEdge </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells wheter this edge is a Line. </p>
<p>This edge is a line edge if</p>
<ul>
<li>at least one of the labels is a line label</li>
<li>any labels which are not line labels have all Locations = EXTERIOR </li>
</ul>
</div>
</div>
<a class="anchor" id="a80dddf917030937d6c023cf532c08e19"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setEdgeDepths" ref="a80dddf917030937d6c023cf532c08e19" args="(int position, int newDepth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::geomgraph::DirectedEdge::setEdgeDepths </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>newDepth</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set both edge depths. </p>
<p>One depth for a given side is provided. The other is computed depending on the Location transition and the depthDelta of the edge. </p>
</div>
</div>
<a class="anchor" id="a8fb7210349aade603246371d2e4bb9f9"></a><!-- doxytag: member="geos::geomgraph::DirectedEdge::setVisitedEdge" ref="a8fb7210349aade603246371d2e4bb9f9" args="(bool newIsVisited)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::geomgraph::DirectedEdge::setVisitedEdge </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>newIsVisited</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Marks both DirectedEdges attached to a given Edge. </p>
<p>This is used for edges corresponding to lines, which will only appear oriented in a single direction in the result. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="geomgraph_2DirectedEdge_8h_source.html">geomgraph/DirectedEdge.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>
