AStarSearch< UserState > Class Template Reference

#include <stlastar.h>

Classes
class	HeapCompare_f
class	Node

Public Types
enum	{   SEARCH_STATE_NOT_INITIALISED, SEARCH_STATE_SEARCHING, SEARCH_STATE_SUCCEEDED, SEARCH_STATE_FAILED,   SEARCH_STATE_OUT_OF_MEMORY, SEARCH_STATE_INVALID }

Public Member Functions
bool	AddSuccessor (UserState &State)
	AStarSearch (int MaxNodes=2000)
void	CancelSearch ()
void	EnsureMemoryFreed ()
void	FreeSolutionNodes ()
UserState *	GetClosedListNext ()
UserState *	GetClosedListNext (float &f, float &g, float &h)
UserState *	GetClosedListStart ()
UserState *	GetClosedListStart (float &f, float &g, float &h)
UserState *	GetOpenListNext ()
UserState *	GetOpenListNext (float &f, float &g, float &h)
UserState *	GetOpenListStart ()
UserState *	GetOpenListStart (float &f, float &g, float &h)
UserState *	GetSolutionEnd ()
UserState *	GetSolutionNext ()
UserState *	GetSolutionPrev ()
UserState *	GetSolutionStart ()
int	GetStepCount ()
unsigned int	SearchStep ()
void	SetStartAndGoalStates (UserState &Start, UserState &Goal)

Private Member Functions
Node *	AllocateNode ()
void	FreeAllNodes ()
void	FreeNode (Node *node)
void	FreeUnusedNodes ()

Private Attributes
vector< Node * >::iterator	iterDbgClosed
vector< Node * >::iterator	iterDbgOpen
int	m_AllocateNodeCount
bool	m_CancelRequest
vector< Node * >	m_ClosedList
Node *	m_CurrentSolutionNode
Node *	m_Goal
vector< Node * >	m_OpenList
Node *	m_Start
unsigned int	m_State
int	m_Steps
vector< Node * >	m_Successors

Detailed Description

template<class UserState>
class AStarSearch< UserState >

Definition at line 54 of file stlastar.h.

Member Enumeration Documentation

template<class UserState>

anonymous enum

Enumerator
SEARCH_STATE_NOT_INITIALISED
SEARCH_STATE_SEARCHING
SEARCH_STATE_SUCCEEDED
SEARCH_STATE_FAILED
SEARCH_STATE_OUT_OF_MEMORY
SEARCH_STATE_INVALID

Definition at line 59 of file stlastar.h.

Constructor & Destructor Documentation

template<class UserState>

AStarSearch< UserState >::AStarSearch ( int  MaxNodes = 2000 )

inline

Definition at line 117 of file stlastar.h.

Member Function Documentation

template<class UserState>

bool AStarSearch< UserState >::AddSuccessor ( UserState &  State )

inline

Definition at line 390 of file stlastar.h.

template<class UserState>

Node* AStarSearch< UserState >::AllocateNode ( )

inlineprivate

Definition at line 683 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::CancelSearch ( )

inline

Definition at line 129 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::EnsureMemoryFreed ( )

inline

Definition at line 595 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::FreeAllNodes ( )

inlineprivate

Definition at line 607 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::FreeNode ( Node *  node )

inlineprivate

Definition at line 702 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::FreeSolutionNodes ( )

inline

Definition at line 409 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::FreeUnusedNodes ( )

inlineprivate

Definition at line 642 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListNext ( )

inline

Definition at line 570 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListNext ( float &  f, float &  g, float &  h  )

inline

Definition at line 576 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListStart ( )

inline

Definition at line 549 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListStart ( float &  f, float &  g, float &  h  )

inline

Definition at line 555 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListNext ( )

inline

Definition at line 529 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListNext ( float &  f, float &  g, float &  h  )

inline

Definition at line 535 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListStart ( )

inline

Definition at line 509 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListStart ( float &  f, float &  g, float &  h  )

inline

Definition at line 515 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionEnd ( )

inline

Definition at line 474 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionNext ( )

inline

Definition at line 455 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionPrev ( )

inline

Definition at line 488 of file stlastar.h.

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionStart ( )

inline

Definition at line 441 of file stlastar.h.

template<class UserState>

int AStarSearch< UserState >::GetStepCount ( )

inline

Definition at line 593 of file stlastar.h.

template<class UserState>

unsigned int AStarSearch< UserState >::SearchStep ( )

inline

Definition at line 169 of file stlastar.h.

template<class UserState>

void AStarSearch< UserState >::SetStartAndGoalStates ( UserState &  Start, UserState &  Goal  )

inline

Definition at line 135 of file stlastar.h.

Member Data Documentation

template<class UserState>

vector< Node * >::iterator AStarSearch< UserState >::iterDbgClosed

private

Definition at line 746 of file stlastar.h.

template<class UserState>

vector< Node * >::iterator AStarSearch< UserState >::iterDbgOpen

private

Definition at line 745 of file stlastar.h.

template<class UserState>

int AStarSearch< UserState >::m_AllocateNodeCount

private

Definition at line 749 of file stlastar.h.

template<class UserState>

bool AStarSearch< UserState >::m_CancelRequest

private

Definition at line 751 of file stlastar.h.

template<class UserState>

vector< Node * > AStarSearch< UserState >::m_ClosedList

private

Definition at line 720 of file stlastar.h.

template<class UserState>

Node* AStarSearch< UserState >::m_CurrentSolutionNode

private

Definition at line 736 of file stlastar.h.

template<class UserState>

Node* AStarSearch< UserState >::m_Goal

private

Definition at line 734 of file stlastar.h.

template<class UserState>

vector< Node *> AStarSearch< UserState >::m_OpenList

private

Definition at line 717 of file stlastar.h.

template<class UserState>

Node* AStarSearch< UserState >::m_Start

private

Definition at line 733 of file stlastar.h.

template<class UserState>

unsigned int AStarSearch< UserState >::m_State

private

Definition at line 727 of file stlastar.h.

template<class UserState>

int AStarSearch< UserState >::m_Steps

private

Definition at line 730 of file stlastar.h.

template<class UserState>

vector< Node * > AStarSearch< UserState >::m_Successors

private

Definition at line 724 of file stlastar.h.

---

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

• stlastar.h