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 ()
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

anonymous enum

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 56 of file stlastar.h.

Constructor & Destructor Documentation

AStarSearch()

template<class UserState>

AStarSearch< UserState >::AStarSearch ( )

inlineexplicit

Definition at line 92 of file stlastar.h.

Member Function Documentation

AddSuccessor()

template<class UserState>

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

inline

Definition at line 329 of file stlastar.h.

AllocateNode()

template<class UserState>

Node* AStarSearch< UserState >::AllocateNode ( )

inlineprivate

Definition at line 588 of file stlastar.h.

CancelSearch()

template<class UserState>

void AStarSearch< UserState >::CancelSearch ( )

inline

Definition at line 103 of file stlastar.h.

EnsureMemoryFreed()

template<class UserState>

void AStarSearch< UserState >::EnsureMemoryFreed ( )

inline

Definition at line 511 of file stlastar.h.

FreeAllNodes()

template<class UserState>

void AStarSearch< UserState >::FreeAllNodes ( )

inlineprivate

Definition at line 521 of file stlastar.h.

FreeNode()

template<class UserState>

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

inlineprivate

Definition at line 605 of file stlastar.h.

FreeSolutionNodes()

template<class UserState>

void AStarSearch< UserState >::FreeSolutionNodes ( )

inline

Definition at line 347 of file stlastar.h.

FreeUnusedNodes()

template<class UserState>

void AStarSearch< UserState >::FreeUnusedNodes ( )

inlineprivate

Definition at line 553 of file stlastar.h.

GetClosedListNext() [1/2]

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListNext ( )

inline

Definition at line 488 of file stlastar.h.

GetClosedListNext() [2/2]

template<class UserState>

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

inline

Definition at line 494 of file stlastar.h.

GetClosedListStart() [1/2]

template<class UserState>

UserState* AStarSearch< UserState >::GetClosedListStart ( )

inline

Definition at line 468 of file stlastar.h.

GetClosedListStart() [2/2]

template<class UserState>

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

inline

Definition at line 474 of file stlastar.h.

GetOpenListNext() [1/2]

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListNext ( )

inline

Definition at line 449 of file stlastar.h.

GetOpenListNext() [2/2]

template<class UserState>

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

inline

Definition at line 455 of file stlastar.h.

GetOpenListStart() [1/2]

template<class UserState>

UserState* AStarSearch< UserState >::GetOpenListStart ( )

inline

Definition at line 430 of file stlastar.h.

GetOpenListStart() [2/2]

template<class UserState>

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

inline

Definition at line 436 of file stlastar.h.

GetSolutionEnd()

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionEnd ( )

inline

Definition at line 401 of file stlastar.h.

GetSolutionNext()

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionNext ( )

inline

Definition at line 385 of file stlastar.h.

GetSolutionPrev()

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionPrev ( )

inline

Definition at line 412 of file stlastar.h.

GetSolutionStart()

template<class UserState>

UserState* AStarSearch< UserState >::GetSolutionStart ( )

inline

Definition at line 374 of file stlastar.h.

GetStepCount()

template<class UserState>

int AStarSearch< UserState >::GetStepCount ( )

inline

Definition at line 510 of file stlastar.h.

SearchStep()

template<class UserState>

unsigned int AStarSearch< UserState >::SearchStep ( )

inline

Definition at line 139 of file stlastar.h.

SetStartAndGoalStates()

template<class UserState>

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

inline

Definition at line 105 of file stlastar.h.

Member Data Documentation

iterDbgClosed

template<class UserState>

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

private

Definition at line 647 of file stlastar.h.

iterDbgOpen

template<class UserState>

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

private

Definition at line 646 of file stlastar.h.

m_AllocateNodeCount

template<class UserState>

int AStarSearch< UserState >::m_AllocateNodeCount

private

Definition at line 650 of file stlastar.h.

m_CancelRequest

template<class UserState>

bool AStarSearch< UserState >::m_CancelRequest

private

Definition at line 652 of file stlastar.h.

m_ClosedList

template<class UserState>

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

private

Definition at line 621 of file stlastar.h.

m_CurrentSolutionNode

template<class UserState>

Node* AStarSearch< UserState >::m_CurrentSolutionNode

private

Definition at line 637 of file stlastar.h.

m_Goal

template<class UserState>

Node* AStarSearch< UserState >::m_Goal

private

Definition at line 635 of file stlastar.h.

m_OpenList

template<class UserState>

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

private

Definition at line 618 of file stlastar.h.

m_Start

template<class UserState>

Node* AStarSearch< UserState >::m_Start

private

Definition at line 634 of file stlastar.h.

m_State

template<class UserState>

unsigned int AStarSearch< UserState >::m_State

private

Definition at line 628 of file stlastar.h.

m_Steps

template<class UserState>

int AStarSearch< UserState >::m_Steps

private

Definition at line 631 of file stlastar.h.

m_Successors

template<class UserState>

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

private

Definition at line 625 of file stlastar.h.

---

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

• stlastar.h