CFindPathConfig Class Reference

Configuration for a 'Find Path From A to B' search. More...

#include <find_cfg.h>

Collaboration diagram for CFindPathConfig:

[legend]List of all members.

Public Member Functions
bool	AllowVisit ()
	Gets whether an additional semantic concept may be visited during searching.
void	VisitNode ()
	Notifies the configuration class that a concept was visited during searching.
void	VisitLink (CSemanticLink *a_link)
	Stores a semantic link in the current working path.
bool	CheckCurrentPath (CSemanticLink *a_link)
	Looks for a specific semantic link in the current working path.
void	SetCurrentPath (CSemanticLinkList *a_list)
	Sets the current working path, removing any previous path items.
void	LeaveNode ()
	Notifies the configuration class that semantic concept processing has stopped for the most recently visited concept.
void	LeaveLink ()
	Notifies the configuration class that semantic link processing has stopped for the most recently visited link.
void	AddPathToResults ()
	Adds the current working path to the list of search results.
u_int	GetNumResults () const
	Gets the number of search results.
CSemanticLinkList *	GetResult (const u_int a_index)
	Gets a specific path search result.
u_int	GetNumNodeVisits () const
	Gets the current number of concepts visited during searching.
CSemanticLinkList *	GetQueuePath ()
	Gets the first available semantic path from the processing queue.
void	QueuePath ()
	Queues the current working path into the processing queue.
	CFindPathConfig ()
	Constructor.
	~CFindPathConfig ()
	Destructor.
Private Types
typedef std::list< CSemanticLinkList * >	CResultsList
	STL list of semantic link paths.
typedef CResultsList::iterator	CResultsList_i
	Iterator for semantic link path STL list.
typedef CResultsList::const_iterator	CResultsList_ci
	Const iterator for semantic link path STL list.
Private Attributes
u_int	m_maxNodeVisits
	Maximum number of concepts that may be visited during searching.
u_int	m_maxNodeResults
	Maximum number of search results to get.
u_int	m_curNodeVisits
	Current number of concepts visted during searching.
u_int	m_curNodeDepth
	Current semantic link depth from source concept.
CSemanticLinkList *	m_currentPath
	Current working path (semantic links from source concept).
CResultsList	m_resultsList
	List of search results.
CResultsList	m_pathQueue
	Processing queue of semantic paths.

---

Detailed Description

Configuration for a 'Find Path From A to B' search.

Definition at line 32 of file find_cfg.h.

---

Member Typedef Documentation

typedef std::list<CSemanticLinkList *> CFindPathConfig::CResultsList [private]

STL list of semantic link paths. Definition at line 192 of file find_cfg.h.

typedef CResultsList::const_iterator CFindPathConfig::CResultsList_ci [private]

Const iterator for semantic link path STL list. Definition at line 197 of file find_cfg.h. Referenced by GetResult().

typedef CResultsList::iterator CFindPathConfig::CResultsList_i [private]

Iterator for semantic link path STL list. Definition at line 195 of file find_cfg.h. Referenced by GetQueuePath().

---

Constructor & Destructor Documentation

CFindPathConfig::CFindPathConfig (   )  [inline]

Constructor. Definition at line 163 of file find_cfg.h. References m_curNodeDepth, m_curNodeVisits, m_currentPath, m_maxNodeResults, and m_maxNodeVisits.

CFindPathConfig::~CFindPathConfig (   )  [inline]

Destructor. Definition at line 175 of file find_cfg.h.

---

Member Function Documentation

void CFindPathConfig::AddPathToResults (   )  [inline]

Adds the current working path to the list of search results. Definition at line 92 of file find_cfg.h. References CSemanticLinkList::Clone(), DPRINT, CSemanticLinkList::GetSize(), m_currentPath, and m_resultsList. Referenced by CSemanticLink::FindPathTo().

Here is the call graph for this function:

bool CFindPathConfig::AllowVisit (   )  [inline]

Gets whether an additional semantic concept may be visited during searching. Definition at line 36 of file find_cfg.h. References m_curNodeVisits, m_maxNodeResults, m_maxNodeVisits, and m_resultsList. Referenced by COMCSNet::FindPathFromA_To_B(), and CSemanticLink::FindPathTo().

bool CFindPathConfig::CheckCurrentPath (  CSemanticLink *  a_link  )  [inline]

Looks for a specific semantic link in the current working path. Definition at line 64 of file find_cfg.h. References CSemanticLinkList::Lookup(), and m_currentPath. Referenced by COMCSNet::FindPathFromA_To_B().

Here is the call graph for this function:

u_int CFindPathConfig::GetNumNodeVisits (   )  const [inline]

Gets the current number of concepts visited during searching. Definition at line 130 of file find_cfg.h. References m_curNodeVisits. Referenced by COMCSNet::FindPathFromA_To_B().

u_int CFindPathConfig::GetNumResults (   )  const [inline]

Gets the number of search results. Definition at line 103 of file find_cfg.h. References m_resultsList. Referenced by COMCSNet::FindPathFromA_To_B().

CSemanticLinkList* CFindPathConfig::GetQueuePath (   )  [inline]

Gets the first available semantic path from the processing queue. Definition at line 136 of file find_cfg.h. References CResultsList_i, and m_pathQueue. Referenced by COMCSNet::FindPathFromA_To_B().

CSemanticLinkList* CFindPathConfig::GetResult (  const u_int  a_index  )  [inline]

Gets a specific path search result. Definition at line 109 of file find_cfg.h. References CResultsList_ci, and m_resultsList.

void CFindPathConfig::LeaveLink (   )  [inline]

Notifies the configuration class that semantic link processing has stopped for the most recently visited link. Definition at line 86 of file find_cfg.h. References m_currentPath, and CSemanticLinkList::Remove(). Referenced by CSemanticLink::FindPathTo().

Here is the call graph for this function:

void CFindPathConfig::LeaveNode (   )  [inline]

Notifies the configuration class that semantic concept processing has stopped for the most recently visited concept. Definition at line 81 of file find_cfg.h. Referenced by CSemanticConcept::FindPathTo().

void CFindPathConfig::QueuePath (   )  [inline]

Queues the current working path into the processing queue. Definition at line 155 of file find_cfg.h. References CSemanticLinkList::Clone(), m_currentPath, and m_pathQueue. Referenced by CSemanticLink::FindPathTo().

Here is the call graph for this function:

void CFindPathConfig::SetCurrentPath (  CSemanticLinkList *  a_list  )  [inline]

Sets the current working path, removing any previous path items. Definition at line 70 of file find_cfg.h. References CSemanticLinkList::Clone(), and m_currentPath. Referenced by COMCSNet::FindPathFromA_To_B().

Here is the call graph for this function:

void CFindPathConfig::VisitLink (  CSemanticLink *  a_link  )  [inline]

Stores a semantic link in the current working path. Definition at line 58 of file find_cfg.h. References m_currentPath, and CSemanticLinkList::Store(). Referenced by CSemanticLink::FindPathTo().

Here is the call graph for this function:

void CFindPathConfig::VisitNode (   )  [inline]

Notifies the configuration class that a concept was visited during searching. Definition at line 52 of file find_cfg.h. References m_curNodeVisits. Referenced by CLinkMap::FindPathTo(), and CSemanticConcept::FindPathTo().

---

Member Data Documentation

u_int CFindPathConfig::m_curNodeDepth [private]

Current semantic link depth from source concept. Definition at line 186 of file find_cfg.h. Referenced by CFindPathConfig().

u_int CFindPathConfig::m_curNodeVisits [private]

Current number of concepts visted during searching. Definition at line 184 of file find_cfg.h. Referenced by AllowVisit(), CFindPathConfig(), GetNumNodeVisits(), and VisitNode().

CSemanticLinkList* CFindPathConfig::m_currentPath [private]

Current working path (semantic links from source concept). Definition at line 189 of file find_cfg.h. Referenced by AddPathToResults(), CFindPathConfig(), CheckCurrentPath(), LeaveLink(), QueuePath(), SetCurrentPath(), and VisitLink().

u_int CFindPathConfig::m_maxNodeResults [private]

Maximum number of search results to get. Definition at line 181 of file find_cfg.h. Referenced by AllowVisit(), and CFindPathConfig().

u_int CFindPathConfig::m_maxNodeVisits [private]

Maximum number of concepts that may be visited during searching. Definition at line 179 of file find_cfg.h. Referenced by AllowVisit(), and CFindPathConfig().

CResultsList CFindPathConfig::m_pathQueue [private]

Processing queue of semantic paths. Definition at line 203 of file find_cfg.h. Referenced by GetQueuePath(), and QueuePath().

CResultsList CFindPathConfig::m_resultsList [private]

List of search results. Definition at line 200 of file find_cfg.h. Referenced by AddPathToResults(), AllowVisit(), GetNumResults(), and GetResult().

---

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

• find_cfg.h

---