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

#include <GraphComponent.h>

Inheritance diagram for geos::planargraph::GraphComponent:

Public Member Functions
	GraphComponent ()

virtual	~GraphComponent ()

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. More...

bool	isVisitedVar
	Variable holding ''visited'' status. More...

Detailed Description

The base class for all graph component classes.

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

marked - 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.
visited - 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.

Definition at line 46 of file planargraph/GraphComponent.h.

Constructor & Destructor Documentation

geos::planargraph::GraphComponent::GraphComponent ( )

inline

Definition at line 58 of file planargraph/GraphComponent.h.

virtual geos::planargraph::GraphComponent::~GraphComponent ( )

inlinevirtual

Definition at line 65 of file planargraph/GraphComponent.h.

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

Definition at line 164 of file planargraph/GraphComponent.h.

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

Definition at line 74 of file planargraph/GraphComponent.h.

template<typename T >

static void geos::planargraph::GraphComponent::setMarked	(	T	start,
		T	end,
		bool	marked
	)

inlinestatic

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

Parameters

start	the start element
end	one past the last element
marked	the state to set the marked flag to

Definition at line 133 of file planargraph/GraphComponent.h.

virtual void geos::planargraph::GraphComponent::setMarked ( bool p_isMarked )

inlinevirtual

Sets the marked flag for this component.

Parameters

p_isMarked the desired value of the marked flag

Definition at line 174 of file planargraph/GraphComponent.h.

template<typename T >

static void geos::planargraph::GraphComponent::setMarkedMap	(	T	start,
		T	end,
		bool	marked
	)

inlinestatic

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

Parameters

start	the start element
end	one past the last element
marked	the state to set the visited flag to

Definition at line 151 of file planargraph/GraphComponent.h.

virtual void geos::planargraph::GraphComponent::setVisited ( bool p_isVisited )

inlinevirtual

Sets the visited flag for this component.

Parameters

p_isVisited the desired value of the visited flag

Definition at line 84 of file planargraph/GraphComponent.h.

template<typename T >

static void geos::planargraph::GraphComponent::setVisited	(	T	start,
		T	end,
		bool	visited
	)

inlinestatic

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

Parameters

start	the start element
end	one past the last element
visited	the state to set the visited flag to

Definition at line 99 of file planargraph/GraphComponent.h.

template<typename T >

static void geos::planargraph::GraphComponent::setVisitedMap	(	T	start,
		T	end,
		bool	visited
	)

inlinestatic

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

Parameters

start	the start element
end	one past the last element
visited	the state to set the visited flag to

Definition at line 116 of file planargraph/GraphComponent.h.

Member Data Documentation

bool geos::planargraph::GraphComponent::isMarkedVar

protected

Variable holding ''marked'' status.

Definition at line 51 of file planargraph/GraphComponent.h.

bool geos::planargraph::GraphComponent::isVisitedVar

protected

Variable holding ''visited'' status.

Definition at line 54 of file planargraph/GraphComponent.h.

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

planargraph/GraphComponent.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation