<!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::GraphComponent 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_1GraphComponent.html">geos::planargraph::GraphComponent</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::planargraph::GraphComponent Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="geos::planargraph::GraphComponent" -->
<p>The base class for all graph component classes.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="planargraph_2GraphComponent_8h_source.html">GraphComponent.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for geos::planargraph::GraphComponent:</div>
<div class="dyncontent">
<div class="center">
<img src="classgeos_1_1planargraph_1_1GraphComponent.png" usemap="#geos::planargraph::GraphComponent_map" alt=""/>
<map id="geos::planargraph::GraphComponent_map" name="geos::planargraph::GraphComponent_map">
<area href="classgeos_1_1planargraph_1_1DirectedEdge.html" alt="geos::planargraph::DirectedEdge" shape="rect" coords="160,56,470,80"/>
<area href="classgeos_1_1planargraph_1_1Edge.html" alt="geos::planargraph::Edge" shape="rect" coords="640,56,950,80"/>
<area href="classgeos_1_1planargraph_1_1Node.html" alt="geos::planargraph::Node" shape="rect" coords="960,56,1270,80"/>
<area href="classgeos_1_1operation_1_1linemerge_1_1LineMergeDirectedEdge.html" alt="geos::operation::linemerge::LineMergeDirectedEdge" shape="rect" coords="0,112,310,136"/>
<area href="classgeos_1_1operation_1_1polygonize_1_1PolygonizeDirectedEdge.html" alt="geos::operation::polygonize::PolygonizeDirectedEdge" shape="rect" coords="320,112,630,136"/>
<area href="classgeos_1_1operation_1_1linemerge_1_1LineMergeEdge.html" alt="geos::operation::linemerge::LineMergeEdge" shape="rect" coords="640,112,950,136"/>
</map>
</div>
<p><a href="classgeos_1_1planargraph_1_1GraphComponent-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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#aede7319ab2fb1d8ed89ed8f59d58d594">isVisited</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests if a component has been visited during the course of a graph algorithm. <a href="#aede7319ab2fb1d8ed89ed8f59d58d594"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#ab72ec2a37b8ae14542098471f05ac147">setVisited</a> (bool isVisited)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the visited flag for this component. <a href="#ab72ec2a37b8ae14542098471f05ac147"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#ad65b94ca5210399c42b248d20a475e10">isMarked</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests if a component has been marked at some point during the processing involving this graph. <a href="#ad65b94ca5210399c42b248d20a475e10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#ac2d86b046fcd76cefaa264d8487f43e2">setMarked</a> (bool isMarked)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the marked flag for this component. <a href="#ac2d86b046fcd76cefaa264d8487f43e2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#a8ff4b23f0099d27e340f4d11de1f4f82">setVisited</a> (T start, T end, bool visited)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Visited state for the elements of a container, from start to end iterator. <a href="#a8ff4b23f0099d27e340f4d11de1f4f82"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#a3a552229e72e062862e1a36936f962f5">setVisitedMap</a> (T start, T end, bool visited)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Visited state for the values of each map container element, from start to end iterator. <a href="#a3a552229e72e062862e1a36936f962f5"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#a3f576f83191374136c3a20bd1b326ec3">setMarked</a> (T start, T end, bool marked)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Marked state for the elements of a container, from start to end iterator. <a href="#a3f576f83191374136c3a20bd1b326ec3"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#ac16da02a410319c86214a59c140deb86">setMarkedMap</a> (T start, T end, bool marked)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Marked state for the values of each map container element, from start to end iterator. <a href="#ac16da02a410319c86214a59c140deb86"></a><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="a9e577ef12e6139e5ade4f7a543250141"></a><!-- doxytag: member="geos::planargraph::GraphComponent::isMarkedVar" ref="a9e577ef12e6139e5ade4f7a543250141" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#a9e577ef12e6139e5ade4f7a543250141">isMarkedVar</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Variable holding ''marked'' status. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaec8b2fc9af6093c7921ab1dd9e2fd4b"></a><!-- doxytag: member="geos::planargraph::GraphComponent::isVisitedVar" ref="aaec8b2fc9af6093c7921ab1dd9e2fd4b" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1planargraph_1_1GraphComponent.html#aaec8b2fc9af6093c7921ab1dd9e2fd4b">isVisitedVar</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Variable holding ''visited'' status. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The base class for all graph component classes. </p>
<p>Maintains flags of use in generic graph algorithms. Provides two flags:</p>
<ul>
<li><b>marked</b> - typically this is used to indicate a state that persists for the course of the graph's lifetime. For instance, it can be used to indicate that a component has been logically deleted from the graph.</li>
<li><b>visited</b> - this is used to indicate that a component has been processed or visited by an single graph algorithm. For instance, a breadth-first traversal of the graph might use this to indicate that a node has already been traversed. The visited flag may be set and cleared many times during the lifetime of a graph. </li>
</ul>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad65b94ca5210399c42b248d20a475e10"></a><!-- doxytag: member="geos::planargraph::GraphComponent::isMarked" ref="ad65b94ca5210399c42b248d20a475e10" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool geos::planargraph::GraphComponent::isMarked </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests if a component has been marked at some point during the processing involving this graph. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the component has been marked </dd></dl>
</div>
</div>
<a class="anchor" id="aede7319ab2fb1d8ed89ed8f59d58d594"></a><!-- doxytag: member="geos::planargraph::GraphComponent::isVisited" ref="aede7319ab2fb1d8ed89ed8f59d58d594" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool geos::planargraph::GraphComponent::isVisited </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests if a component has been visited during the course of a graph algorithm. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the component has been visited </dd></dl>
</div>
</div>
<a class="anchor" id="a3f576f83191374136c3a20bd1b326ec3"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setMarked" ref="a3f576f83191374136c3a20bd1b326ec3" args="(T start, T end, bool marked)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">static void geos::planargraph::GraphComponent::setMarked </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>marked</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Marked state for the elements of a container, from start to end iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the start element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>one past the last element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>marked</em> </td><td>the state to set the marked flag to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac2d86b046fcd76cefaa264d8487f43e2"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setMarked" ref="ac2d86b046fcd76cefaa264d8487f43e2" args="(bool isMarked)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::planargraph::GraphComponent::setMarked </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>isMarked</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the marked flag for this component. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>isMarked</em> </td><td>the desired value of the marked flag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac16da02a410319c86214a59c140deb86"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setMarkedMap" ref="ac16da02a410319c86214a59c140deb86" args="(T start, T end, bool marked)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">static void geos::planargraph::GraphComponent::setMarkedMap </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>marked</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Marked state for the values of each map container element, from start to end iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the start element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>one past the last element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>marked</em> </td><td>the state to set the visited flag to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8ff4b23f0099d27e340f4d11de1f4f82"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setVisited" ref="a8ff4b23f0099d27e340f4d11de1f4f82" args="(T start, T end, bool visited)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">static void geos::planargraph::GraphComponent::setVisited </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>visited</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Visited state for the elements of a container, from start to end iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the start element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>one past the last element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>visited</em> </td><td>the state to set the visited flag to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab72ec2a37b8ae14542098471f05ac147"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setVisited" ref="ab72ec2a37b8ae14542098471f05ac147" args="(bool isVisited)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void geos::planargraph::GraphComponent::setVisited </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>isVisited</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the visited flag for this component. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>isVisited</em> </td><td>the desired value of the visited flag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3a552229e72e062862e1a36936f962f5"></a><!-- doxytag: member="geos::planargraph::GraphComponent::setVisitedMap" ref="a3a552229e72e062862e1a36936f962f5" args="(T start, T end, bool visited)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">static void geos::planargraph::GraphComponent::setVisitedMap </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>visited</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Visited state for the values of each map container element, from start to end iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>the start element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>one past the last element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>visited</em> </td><td>the state to set the visited flag to </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="planargraph_2GraphComponent_8h_source.html">planargraph/GraphComponent.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>
