ITK  4.6.0
Insight Segmentation and Registration Toolkit
itkStoppingCriterionBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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:
42  typedef Object Superclass;
45 
46  itkTypeMacro(StoppingCriterionBase, Object);
47 
51  virtual bool IsSatisfied() const = 0;
52  virtual std::string GetDescription() const = 0;
54 
55 protected:
59  virtual ~StoppingCriterionBase();
60 
61 private:
62  StoppingCriterionBase( const Self& );
63  void operator = ( const Self& );
64 };
65 
66 }
67 #endif
Light weight base class for most itk classes.
SmartPointer< const Self > ConstPointer
Base class for most ITK classes.
Definition: itkObject.h:57
An abstract base class to represent a stopping criterion for an iterative algorithm.