Computer Assited Medical Intervention Tool Kit  version 5.0
MultipleCriterion.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, 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_STOPPINGCRITERIA_MULTIPLECRITERION_H
28 #define STOPPINGCRITERION_STOPPINGCRITERIA_MULTIPLECRITERION_H
29 
30 #include <vector>
31 
32 #include <MonitorIn.hxx>
33 // Stopping criteria includes
34 #include "StoppingCriterion.h"
46 public:
51  MultipleCriterion(mml::MultipleCriteria* m, MonitoringManager* monitoringManager, MultipleCriterion* parent = nullptr);
53  ~MultipleCriterion() override;
54 
56  bool checkCriterion() override = 0;
57 
59  int getNumberOfChildren() override;
60 
62  StoppingCriterion* getChild(const unsigned int i) override;
63 
65  std::string getName() override = 0;
66 
68  void addChild(StoppingCriterion* sc);
69 
71  void removeChild(const unsigned int i);
72 
73 protected:
75  std::vector<StoppingCriterion*> criterias;
77  mml::MultipleCriteria* mappedObject;
78 };
79 
80 #endif // STOPPINGCRITERION_STOPPINGCRITERIA_MULTIPLECRITERION_H
MultipleCriterion::mappedObject
mml::MultipleCriteria * mappedObject
the xsdcxx object representing MultipleCriterion, used for serialization
Definition: MultipleCriterion.h:100
MultipleCriterion::~MultipleCriterion
~MultipleCriterion() override
destructor
Definition: MultipleCriterion.cpp:50
CriterionFactory::createCriterion
static Criterion * createCriterion(mml::Criteria *c, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
create a criterion according to the xsdcxx object criterion
Definition: CriterionFactory.cpp:38
CriterionFactory.h
MultipleCriterion::MultipleCriterion
MultipleCriterion(mml::MultipleCriteria *m, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
constructor
Definition: MultipleCriterion.cpp:37
MultipleCriterion::removeChild
void removeChild(const unsigned int i)
remove child by index
Definition: MultipleCriterion.cpp:78
MultipleCriterion::criterias
std::vector< StoppingCriterion * > criterias
the set of criteria to check
Definition: MultipleCriterion.h:98
MultipleCriterionFactory.h
MultipleCriterion::addChild
void addChild(StoppingCriterion *sc)
add child
Definition: MultipleCriterion.cpp:73
MultipleCriterion::checkCriterion
bool checkCriterion() override=0
return true if the MultipleCriterion is reach
StoppingCriterion.h
MultipleCriterion::getName
std::string getName() override=0
get stopping criterion name
MonitoringManager
Manager of the benchmark tests. Do simulation loop and tests.
Definition: MonitoringManager.h:50
StoppingCriterion
class which represent the stopping criterion to check to stop simulation a StoppingCriterion is eithe...
Definition: StoppingCriterion.h:48
MultipleCriterion.h
StoppingCriterion::parent
MultipleCriterion * parent
parent stopping Criterion
Definition: StoppingCriterion.h:76
MultipleCriterionFactory::createMultipleCriteria
static MultipleCriterion * createMultipleCriteria(mml::MultipleCriteria *m, MonitoringManager *monitoringManager, MultipleCriterion *parent=nullptr)
create a criterion according to the xsdcxx object MultipleCriterion
Definition: MultipleCriterionFactory.cpp:38
MultipleCriterion
class which represents a multiple criterion a multiple criterion is either an OrMUltipleCriterion or ...
Definition: MultipleCriterion.h:45
StoppingCriterion::monitoringManager
MonitoringManager * monitoringManager
monitoring manager
Definition: StoppingCriterion.h:74
MultipleCriterion::getChild
StoppingCriterion * getChild(const unsigned int i) override
get the child repered by index, return null if no child
Definition: MultipleCriterion.cpp:63
MultipleCriterion::getNumberOfChildren
int getNumberOfChildren() override
get number of childre; return -1 for non multiple criteria
Definition: MultipleCriterion.cpp:58