Main Page | Alphabetical List | Compound List | File List | Compound Members | File Members

CFindContextConfig Class Reference

Configuration for a 'Find Context Concepts' search. More...

#include <findc_cfg.h>

List of all members.

Public Member Functions

bool AllowVisit ()
 Gets whether an additional semantic concept can be visited during searching.

void VisitNode ()
 Notifies the configuration class that a semantic concept was visited during searching.

float GetDiscountFactor () const
 Gets the score reduction factor used for discounting the weight of concepts during searching.

bool AddNodeToResults (CSemanticConcept *a_concept, const float a_score)
 Adds a concept to the search results list.

u_int GetNumResults () const
 Gets the number of search results.

CSemanticConceptGetResult (const u_int a_index, float *a_score)
 Gets a specific search result.

u_int GetNumNodeVisits () const
 Gets the current number of concepts visited during searching.

CResultsList_i GetScoreIterator ()
 Gets an iterator pointing to the beginning of the scored concepts queue.

CSemanticConceptGetScoreQueue (CResultsList_i &a_iter, float *a_score)
 Gets a scored concept from the processing queue using an iterator.

CSemanticConceptGetScoreQueue (float *a_score)
 Gets the first available scored concept from the processing queue, removing it from the queue.

void QueueScore (CSemanticConcept *a_concept, const float a_score)
 Queues a concept in the processing queue along with its associated score.

 CFindContextConfig ()
 Constructor.

virtual ~CFindContextConfig ()
 Destructor.


Private Attributes

u_int m_maxNodeVisits
 Maximum number of concepts to be visited during searching.

u_int m_maxNodeResults
 Maximum number of search results to return.

u_int m_curNodeVisits
 Current number of concepts visited during search processing.

CResultsList m_resultsList
 List of search results.

CResultsList m_scoreQueue
 Processing queue of scored semantic concepts.


Detailed Description

Configuration for a 'Find Context Concepts' search.

Definition at line 42 of file findc_cfg.h.


Constructor & Destructor Documentation

CFindContextConfig::CFindContextConfig  )  [inline]
 

Constructor.

Definition at line 197 of file findc_cfg.h.

References m_curNodeVisits, m_maxNodeResults, and m_maxNodeVisits.

virtual CFindContextConfig::~CFindContextConfig  )  [inline, virtual]
 

Destructor.

Definition at line 206 of file findc_cfg.h.


Member Function Documentation

bool CFindContextConfig::AddNodeToResults CSemanticConcept a_concept,
const float  a_score
[inline]
 

Adds a concept to the search results list.

Definition at line 69 of file findc_cfg.h.

References CSemanticConceptPair, m_maxNodeResults, and m_resultsList.

Referenced by COMCSNet::FindContext().

bool CFindContextConfig::AllowVisit  )  [inline]
 

Gets whether an additional semantic concept can be visited during searching.

Definition at line 46 of file findc_cfg.h.

References m_curNodeVisits, and m_maxNodeVisits.

Referenced by COMCSNet::FindContext(), and COMCSNet::p_FindContextProcessLinkMap().

float CFindContextConfig::GetDiscountFactor  )  const [inline]
 

Gets the score reduction factor used for discounting the weight of concepts during searching.

Definition at line 63 of file findc_cfg.h.

Referenced by COMCSNet::p_FindContextProcessLinkMap().

u_int CFindContextConfig::GetNumNodeVisits  )  const [inline]
 

Gets the current number of concepts visited during searching.

Definition at line 121 of file findc_cfg.h.

References m_curNodeVisits.

u_int CFindContextConfig::GetNumResults  )  const [inline]
 

Gets the number of search results.

Definition at line 88 of file findc_cfg.h.

References m_resultsList.

Referenced by COMCSNet::FindContext().

CSemanticConcept* CFindContextConfig::GetResult const u_int  a_index,
float *  a_score
[inline]
 

Gets a specific search result.

Definition at line 94 of file findc_cfg.h.

References CResultsList_ci, and m_resultsList.

CResultsList_i CFindContextConfig::GetScoreIterator  )  [inline]
 

Gets an iterator pointing to the beginning of the scored concepts queue.

Definition at line 127 of file findc_cfg.h.

References CResultsList_i, DPRINT, and m_scoreQueue.

Referenced by COMCSNet::FindContext().

CSemanticConcept* CFindContextConfig::GetScoreQueue float *  a_score  )  [inline]
 

Gets the first available scored concept from the processing queue, removing it from the queue.

Definition at line 159 of file findc_cfg.h.

References CResultsList_i, and m_scoreQueue.

CSemanticConcept* CFindContextConfig::GetScoreQueue CResultsList_i a_iter,
float *  a_score
[inline]
 

Gets a scored concept from the processing queue using an iterator.

Definition at line 136 of file findc_cfg.h.

References m_scoreQueue.

Referenced by COMCSNet::FindContext().

void CFindContextConfig::QueueScore CSemanticConcept a_concept,
const float  a_score
[inline]
 

Queues a concept in the processing queue along with its associated score.

Definition at line 185 of file findc_cfg.h.

References CSemanticConceptPair, and m_scoreQueue.

Referenced by COMCSNet::FindContext(), and COMCSNet::p_FindContextProcessLinkMap().

void CFindContextConfig::VisitNode  )  [inline]
 

Notifies the configuration class that a semantic concept was visited during searching.

Definition at line 57 of file findc_cfg.h.

References m_curNodeVisits.

Referenced by COMCSNet::p_FindContextProcessLinkMap().


Member Data Documentation

u_int CFindContextConfig::m_curNodeVisits [private]
 

Current number of concepts visited during search processing.

Definition at line 215 of file findc_cfg.h.

Referenced by AllowVisit(), CFindContextConfig(), GetNumNodeVisits(), and VisitNode().

u_int CFindContextConfig::m_maxNodeResults [private]
 

Maximum number of search results to return.

Definition at line 212 of file findc_cfg.h.

Referenced by AddNodeToResults(), and CFindContextConfig().

u_int CFindContextConfig::m_maxNodeVisits [private]
 

Maximum number of concepts to be visited during searching.

Definition at line 210 of file findc_cfg.h.

Referenced by AllowVisit(), and CFindContextConfig().

CResultsList CFindContextConfig::m_resultsList [private]
 

List of search results.

Definition at line 218 of file findc_cfg.h.

Referenced by AddNodeToResults(), GetNumResults(), and GetResult().

CResultsList CFindContextConfig::m_scoreQueue [private]
 

Processing queue of scored semantic concepts.

Definition at line 221 of file findc_cfg.h.

Referenced by GetScoreIterator(), GetScoreQueue(), and QueueScore().


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 09:44:38 2003 for OMCSNetCPP by doxygen 1.3.3