Computer Assisted Medical Intervention Tool Kit  version 5.2
StoppingCriterion Class Referenceabstract

class which represent the stopping criterion to check to stop simulation a StoppingCriterion is either a Criterion or a MultipleCriterion a StoppingCriterion can be checked using checkCriterion method to know if the StoppingCriterion is reach More...

#include <StoppingCriterion.h>

+ Inheritance diagram for StoppingCriterion:
+ Collaboration diagram for StoppingCriterion:

Public Member Functions

virtual bool checkCriterion ()=0
 return true if the stopping criterion is reach More...
 
virtual StoppingCriteriongetChild (const unsigned int i)=0
 get the child repered by index, return nullptr if no child More...
 
virtual std::string getName ()=0
 get stopping criterion name More...
 
virtual int getNumberOfChildren ()=0
 get number of childre; return -1 for non multiple criteria More...
 
MultipleCriteriongetParent ()
 get parent multiple criteria More...
 
 StoppingCriterion (MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
 constructor More...
 
virtual ~StoppingCriterion ()=default
 destructor More...
 

Protected Attributes

MonitoringManagermonitoringManager
 monitoring manager More...
 
MultipleCriterionparent
 parent stopping Criterion More...
 

Detailed Description

class which represent the stopping criterion to check to stop simulation a StoppingCriterion is either a Criterion or a MultipleCriterion a StoppingCriterion can be checked using checkCriterion method to know if the StoppingCriterion is reach

Constructor & Destructor Documentation

◆ StoppingCriterion()

StoppingCriterion::StoppingCriterion ( MonitoringManager monitoringManager,
MultipleCriterion parent = nullptr 
)

constructor

References monitoringManager, and parent.

◆ ~StoppingCriterion()

virtual StoppingCriterion::~StoppingCriterion ( )
virtualdefault

destructor

Member Function Documentation

◆ checkCriterion()

virtual bool StoppingCriterion::checkCriterion ( )
pure virtual

return true if the stopping criterion is reach

Implemented in MultipleCriterion, OrMultipleCriterion, Criterion, and AndMultipleCriterion.

Referenced by InteractiveMonitoringManager::checkStop().

+ Here is the caller graph for this function:

◆ getChild()

virtual StoppingCriterion* StoppingCriterion::getChild ( const unsigned int  i)
pure virtual

get the child repered by index, return nullptr if no child

Implemented in MultipleCriterion, and Criterion.

◆ getName()

virtual std::string StoppingCriterion::getName ( )
pure virtual

◆ getNumberOfChildren()

virtual int StoppingCriterion::getNumberOfChildren ( )
pure virtual

get number of childre; return -1 for non multiple criteria

Implemented in MultipleCriterion, and Criterion.

◆ getParent()

MultipleCriterion * StoppingCriterion::getParent ( )

get parent multiple criteria

References parent.

Member Data Documentation

◆ monitoringManager

MonitoringManager* StoppingCriterion::monitoringManager
protected

◆ parent

MultipleCriterion* StoppingCriterion::parent
protected

parent stopping Criterion

Referenced by getParent(), and StoppingCriterion().


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