GEOS  3.8.0dev
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
geos::planargraph::GraphComponent Class Reference

The base class for all graph component classes. More...

#include <GraphComponent.h>

Inheritance diagram for geos::planargraph::GraphComponent:
geos::planargraph::DirectedEdge geos::planargraph::Edge geos::planargraph::Node geos::operation::linemerge::LineMergeDirectedEdge geos::operation::polygonize::PolygonizeDirectedEdge geos::operation::linemerge::LineMergeEdge

Public Member Functions

virtual bool isVisited () const
 Tests if a component has been visited during the course of a graph algorithm. More...
 
virtual void setVisited (bool p_isVisited)
 Sets the visited flag for this component. More...
 
virtual bool isMarked () const
 Tests if a component has been marked at some point during the processing involving this graph. More...
 
virtual void setMarked (bool p_isMarked)
 Sets the marked flag for this component. More...
 

Static Public Member Functions

template<typename T >
static void setVisited (T start, T end, bool visited)
 Sets the Visited state for the elements of a container, from start to end iterator. More...
 
template<typename T >
static void setVisitedMap (T start, T end, bool visited)
 Sets the Visited state for the values of each map container element, from start to end iterator. More...
 
template<typename T >
static void setMarked (T start, T end, bool marked)
 Sets the Marked state for the elements of a container, from start to end iterator. More...
 
template<typename T >
static void setMarkedMap (T start, T end, bool marked)
 Sets the Marked state for the values of each map container element, from start to end iterator. More...
 

Protected Attributes

bool isMarkedVar
 Variable holding ''marked'' status.
 
bool isVisitedVar
 Variable holding ''visited'' status.
 

Detailed Description

The base class for all graph component classes.

Maintains flags of use in generic graph algorithms. Provides two flags:

Member Function Documentation

virtual bool geos::planargraph::GraphComponent::isMarked ( ) const
inlinevirtual

Tests if a component has been marked at some point during the processing involving this graph.

Returns
true if the component has been marked
virtual bool geos::planargraph::GraphComponent::isVisited ( ) const
inlinevirtual

Tests if a component has been visited during the course of a graph algorithm.

Returns
true if the component has been visited
template<typename T >
static void geos::planargraph::GraphComponent::setMarked ( start,
end,
bool  marked 
)
inlinestatic

Sets the Marked state for the elements of a container, from start to end iterator.

Parameters
startthe start element
endone past the last element
markedthe state to set the marked flag to
virtual void geos::planargraph::GraphComponent::setMarked ( bool  p_isMarked)
inlinevirtual

Sets the marked flag for this component.

Parameters
isMarkedthe desired value of the marked flag
template<typename T >
static void geos::planargraph::GraphComponent::setMarkedMap ( start,
end,
bool  marked 
)
inlinestatic

Sets the Marked state for the values of each map container element, from start to end iterator.

Parameters
startthe start element
endone past the last element
markedthe state to set the visited flag to
virtual void geos::planargraph::GraphComponent::setVisited ( bool  p_isVisited)
inlinevirtual

Sets the visited flag for this component.

Parameters
isVisitedthe desired value of the visited flag
template<typename T >
static void geos::planargraph::GraphComponent::setVisited ( start,
end,
bool  visited 
)
inlinestatic

Sets the Visited state for the elements of a container, from start to end iterator.

Parameters
startthe start element
endone past the last element
visitedthe state to set the visited flag to
template<typename T >
static void geos::planargraph::GraphComponent::setVisitedMap ( start,
end,
bool  visited 
)
inlinestatic

Sets the Visited state for the values of each map container element, from start to end iterator.

Parameters
startthe start element
endone past the last element
visitedthe state to set the visited flag to

The documentation for this class was generated from the following file: