Index   Main   Namespaces   Classes   Hierarchy   Annotated   Files   Compound   Global   Pages  

SgNodeSearchControl Class Reference

#include <SgSearchControl.h>

Inheritance diagram for SgNodeSearchControl:

Inheritance graph
List of all members.

Detailed Description

Example of a simple search abort class: abort when node limit is reached.

Definition at line 93 of file SgSearchControl.h.

Public Member Functions

 SgNodeSearchControl (int maxNumNodes)
virtual ~SgNodeSearchControl ()
virtual bool Abort (double ignoreElapsedTime, int numNodes)
 Check if search should be aborted.
void SetMaxNumNodes (int maxNumNodes)
virtual bool StartNextIteration (int depth, double elapsedTime, int numNodes)
 Check if next iteration should be started.

Private Member Functions

 SgNodeSearchControl (const SgNodeSearchControl &)
 Not implemented.
SgNodeSearchControloperator= (const SgNodeSearchControl &)
 Not implemented.

Private Attributes

int m_maxNumNodes

Constructor & Destructor Documentation

SgNodeSearchControl::SgNodeSearchControl ( int  maxNumNodes  ) 

Definition at line 44 of file SgSearchControl.cpp.

SgNodeSearchControl::~SgNodeSearchControl (  )  [virtual]

Definition at line 48 of file SgSearchControl.cpp.

SgNodeSearchControl::SgNodeSearchControl ( const SgNodeSearchControl  )  [private]

Not implemented.

Member Function Documentation

bool SgNodeSearchControl::Abort ( double  ignoreElapsedTime,
int  numNodes 
) [virtual]

Check if search should be aborted.

Called at each node.

Implements SgSearchControl.

Definition at line 52 of file SgSearchControl.cpp.

References m_maxNumNodes, and SG_UNUSED().

SgNodeSearchControl& SgNodeSearchControl::operator= ( const SgNodeSearchControl  )  [private]

Not implemented.

void SgNodeSearchControl::SetMaxNumNodes ( int  maxNumNodes  ) 

Definition at line 115 of file SgSearchControl.h.

References m_maxNumNodes.

bool SgSearchControl::StartNextIteration ( int  depth,
double  elapsedTime,
int  numNodes 
) [virtual, inherited]

Check if next iteration should be started.

Called before each iteration. The default implementation always returns true.

depth The depth of the next iteration.
elapsedTime The elapsed time in seconds.
numNodes The number of nodes visited.

Definition at line 16 of file SgSearchControl.cpp.

References SG_UNUSED().

Referenced by SgSearch::IteratedSearch().

Member Data Documentation

int SgNodeSearchControl::m_maxNumNodes [private]

Definition at line 106 of file SgSearchControl.h.

Referenced by Abort(), and SetMaxNumNodes().

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

17 Jun 2010 Doxygen 1.4.7