PathFind::Environment Class Reference

#include <environment.h>

Inheritance diagram for PathFind::Environment:

[legend]List of all members.

---

Detailed Description

Interface to search environment.

Definition at line 24 of file environment.h.

Public Member Functions
virtual	~Environment ()
virtual int	getHeuristic (int start, int target) const=0
virtual int	getMaxCost () const=0
virtual int	getMinCost () const=0
virtual int	getNumberNodes () const=0
virtual void	getSuccessors (int nodeId, int lastNodeId, vector< Successor > &result) const=0
	Generate successor nodes for the search.
virtual bool	isValidNodeId (int nodeId) const=0

---

Constructor & Destructor Documentation

Environment::~Environment (   )  [virtual]

Definition at line 17 of file environment.cpp.

---

Member Function Documentation

virtual int PathFind::Environment::getHeuristic (  int  start, int  target )  const [pure virtual]

Implemented in PathFind::Tiling. Referenced by PathFind::FringeSearch< MARKER >::doIteration(), PathFind::AStar< MARKER, CLOSED >::findPathAStar(), PathFind::IDAStar::findPathIdaStar(), and PathFind::IDAStar::searchPathIdaStar().

virtual int PathFind::Environment::getMaxCost (   )  const [pure virtual]

Implemented in PathFind::Tiling. Referenced by PathFind::IDAStar::findPathIdaStar().

virtual int PathFind::Environment::getMinCost (   )  const [pure virtual]

Implemented in PathFind::Tiling. Referenced by PathFind::IDAStar::findPathIdaStar().

virtual int PathFind::Environment::getNumberNodes (   )  const [pure virtual]

Implemented in PathFind::Tiling. Referenced by PathFind::AStar< MARKER, CLOSED >::findPathAStar(), PathFind::IDAStar::findPathIdaStar(), and PathFind::SearchUtils::findRandomStartTarget().

virtual void PathFind::Environment::getSuccessors (  int  nodeId, int  lastNodeId, vector< Successor > &  result )  const [pure virtual]

Generate successor nodes for the search. Parameters: nodeId  Current node lastNodeId  Can be used to prune nodes, (is set to NO_NODE in Search::checkPathExists). result  Resulting successors. Passed in as a reference to avoid dynamic memory allocation. The vector will be cleared and filled with the successors. Implemented in PathFind::Tiling. Referenced by PathFind::FringeSearch< MARKER >::doIteration(), PathFind::AStar< MARKER, CLOSED >::findPathAStar(), PathFind::SearchUtils::searchPathExists(), and PathFind::IDAStar::searchPathIdaStar().

virtual bool PathFind::Environment::isValidNodeId (  int  nodeId  )  const [pure virtual]

Implemented in PathFind::Tiling. Referenced by PathFind::IDAStar::findPath(), PathFind::FringeSearch< MARKER >::findPath(), PathFind::AStar< MARKER, CLOSED >::findPath(), PathFind::SearchUtils::findRandomStartTarget(), and PathFind::SearchUtils::searchPathExists().

---

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

• environment.h
• environment.cpp

---