Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
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:

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 null 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=NULL)
 constructor More...
 
virtual ~StoppingCriterion ()
 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 ( MonitoringManager monitoringManager,
MultipleCriterion parent = NULL 
)

constructor

virtual StoppingCriterion::~StoppingCriterion ( )
virtual

destructor

Member Function Documentation

virtual bool StoppingCriterion::checkCriterion ( )
pure virtual

return true if the stopping criterion is reach

Implemented in Criterion, MultipleCriterion, AndMultipleCriterion, and OrMultipleCriterion.

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

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

Implemented in Criterion, and MultipleCriterion.

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

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

Implemented in Criterion, and MultipleCriterion.

MultipleCriterion* StoppingCriterion::getParent ( )

get parent multiple criteria

Member Data Documentation

MonitoringManager* StoppingCriterion::monitoringManager
protected

monitoring manager

MultipleCriterion* StoppingCriterion::parent
protected

parent stopping Criterion


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