ITK  5.3.0
Insight Toolkit
itkStoppingCriterionBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef itkStoppingCriterionBase_h
20 #define itkStoppingCriterionBase_h
21 
22 #include "itkObject.h"
23 #include "itkObjectFactoryBase.h"
24 #include "itkMacro.h"
25 
26 namespace itk
27 {
38 class ITKCommon_EXPORT StoppingCriterionBase : public Object
39 {
40 public:
41  ITK_DISALLOW_COPY_AND_MOVE(StoppingCriterionBase);
42 
44  using Superclass = Object;
47 
48  itkTypeMacro(StoppingCriterionBase, Object);
49 
53  virtual bool
54  IsSatisfied() const = 0;
55  virtual std::string
56  GetDescription() const = 0;
58 
59 protected:
63  ~StoppingCriterionBase() override;
64 };
65 
66 } // namespace itk
67 #endif
itk::SmartPointer< Self >
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkObjectFactoryBase.h
itkMacro.h
itkObject.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::StoppingCriterionBase
An abstract base class to represent a stopping criterion for an iterative algorithm.
Definition: itkStoppingCriterionBase.h:38
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62