Computer Assisted Medical Intervention Tool Kit  version 5.2
StoppingCriterion.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 
27 #ifndef STOPPINGCRITERION_STOPPINGCRITERION_H
28 #define STOPPINGCRITERION_STOPPINGCRITERION_H
29 
30 #include "MMLAPI.h"
31 
32 #include <vector>
33 
34 #include <MonitorIn.hxx>
35 
36 #include "MonitoringManager.h"
37 
38 class MultipleCriterion;
49 public:
50 
52  StoppingCriterion(MonitoringManager* monitoringManager, MultipleCriterion* parent = nullptr);
54  virtual ~StoppingCriterion() = default;
55 
57  virtual bool checkCriterion() = 0;
58 
60  virtual int getNumberOfChildren() = 0;
61 
63  virtual StoppingCriterion* getChild(const unsigned int i) = 0;
64 
66  MultipleCriterion* getParent();
67 
69  virtual std::string getName() = 0;
70 
71 protected:
72 
77 
78 };
79 
80 #endif // STOPPINGCRITERION_STOPPINGCRITERION_H
#define MML_API
Definition: MMLAPI.h:43
Manager of the benchmark tests.
Definition: MonitoringManager.h:50
class which represents a multiple criterion a multiple criterion is either an OrMUltipleCriterion or ...
Definition: MultipleCriterion.h:45
class which represent the stopping criterion to check to stop simulation a StoppingCriterion is eithe...
Definition: StoppingCriterion.h:48
virtual bool checkCriterion()=0
return true if the stopping criterion is reach
virtual int getNumberOfChildren()=0
get number of childre; return -1 for non multiple criteria
virtual ~StoppingCriterion()=default
destructor
virtual std::string getName()=0
get stopping criterion name
MultipleCriterion * parent
parent stopping Criterion
Definition: StoppingCriterion.h:76
MonitoringManager * monitoringManager
monitoring manager
Definition: StoppingCriterion.h:74
virtual StoppingCriterion * getChild(const unsigned int i)=0
get the child repered by index, return nullptr if no child